fix: docs not being built in gh-pages

[r3yc0n1c]

fixes #256

ref PR #260

Summary by Sourcery

Update the GitHub Pages deployment workflow to build and deploy the documentation from the main and development branches instead of the deployment branch.

CI:

• Deploy documentation to GitHub Pages from the main and development branches.

Documentation:

• Build the documentation in the doc directory.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR fixes the documentation deployment issue by updating the GitHub Actions deploy workflow. The branch trigger configuration was modified to listen to pushes on 'development' and 'main', and an extraneous comment regarding the Sphinx docs directory was removed for clarity.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Modify branch trigger configuration in the deploy workflow	Replaced the 'deployment' branch with an array [development, main] to ensure docs are built from the correct branches	.github/workflows/deploy.yml
Clean up working-directory configuration	Removed the note comment regarding the Sphinx docs directory from the working-directory specification	.github/workflows/deploy.yml

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#256	Create a GitHub Actions workflow to automatically deploy Sphinx documentation to the gh-pages branch	✅
#256	Configure the workflow to build documentation from the correct directory	✅
#256	Trigger documentation deployment on pushes to main and development branches	✅

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @r3yc0n1c - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using a wildcard for the branches if you want to include all branches.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[mariobehling]

Good job! It builds in the gh-pages branch.

To do: Delete the CNAME in the dev branch. Automatically create the CNAME on deployment in the gh-pages branch. I added the CNAME manually for now.

[r3yc0n1c]

sure, I'll add it in the workflow itself