create docs deploy workflow

[r3yc0n1c]

fixes #300

Screenshot

Summary

• create the gh-pages Branch
• added github workflow to build and deploy the documentation automatically to the branch gh-pages
• added CNAME file to the root directory.

Summary by Sourcery

Set up automatic deployment of Sphinx documentation to GitHub Pages on the gh-pages branch from the development branch.

CI:

• Add CI workflow to automatically build and deploy documentation to GitHub Pages on push to the development branch.

Deployment:

• Deploy documentation to the gh-pages branch.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request introduces a new GitHub Actions workflow to automatically build and deploy the Sphinx documentation to the gh-pages branch. It also adds a CNAME file to the root directory.

Sequence diagram for documentation deployment workflow

sequenceDiagram
    participant GH as GitHub Repository
    participant WF as GitHub Workflow
    participant Py as Python Environment
    participant Doc as Sphinx Docs
    participant GP as GitHub Pages

    Note over GH: Push to development branch
    GH->>WF: Trigger workflow
    WF->>GH: Checkout repository
    WF->>Py: Setup Python 3.11
    WF->>Py: Install dependencies
    Py->>Doc: Build HTML documentation
    WF->>GP: Deploy to gh-pages branch
    Note over GP: Documentation live

Loading

File-Level Changes

Change	Details	Files
Added a GitHub Actions workflow to build and deploy documentation.	Configured the workflow to trigger on pushes to the development branch. Set up a job to run on Ubuntu. Checked out the repository. Set up Python 3.11. Installed documentation dependencies. Built the Sphinx documentation. Deployed the documentation to the gh-pages branch using the peaceiris/actions-gh-pages action.	.github/workflows/deploy.yml
Added a CNAME file to the root directory.	Added a CNAME file.	CNAME

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#300	Create a GitHub Actions workflow to automatically deploy Sphinx documentation to the gh-pages branch	✅
#300	Set up the gh-pages branch for GitHub Pages deployment	✅
#300	Configure a custom subdomain for documentation hosting	✅

Possibly linked issues

• Deploy the documentation automatically to the branch gh-pages and Github Actions #300: The PR implements the automatic deployment of documentation to the gh-pages branch using GitHub Actions, as requested in the issue.

---

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.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a 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. You can also use
  this command to specify where the summary should be inserted.

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 triggering the documentation deployment from the main/master branch instead of development to ensure published docs match the stable version of the codebase.
• The CNAME file appears to be empty - it should contain the custom domain name if you're planning to use a custom domain for GitHub Pages.

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.}