Documentation

[flechtenberg]

Pull Request: Finalize Documentation on documentation Branch

This pull request includes the finalized version of the project documentation, incorporating various improvements, fixes, and testing updates. Below is a summary of the changes made:

Summary of Changes:

1. Completed Documentation:

   • Added initial project documentation, including:
   • Improved and expanded content for clarity and completeness.

2. Fixes and Refinements:

   • Fixed numerous typos and improved writing for consistency and readability.
   • Updated conf.py with additional configurations for Sphinx, improving build customization.

3. Workflow Adjustments:

   • Added and tested GitHub Actions workflows for automatic documentation deployment.
   • Subsequently removed the workflow as part of the transition to local builds and deployment.

4. Build Artifacts and .gitignore:

   • Updated .gitignore to exclude documentation build artifacts, ensuring a cleaner repository.
   • Removed artifact files from the repository.

Next Steps:

• After merging this pull request into master, I will locally build the documentation and deploy it to the gh-pages branch.