feat(development): deploy Sphinx Documentation automatically to gh-pages using GitHub Actions

[r3yc0n1c]

Fixes issue #256. It does so by automating the deployment of Sphinx documentation (development) to the gh-pages branch using GitHub Actions. With this workflow, every update to the documentation triggers a deployment, ensuring that the latest changes are always reflected on GitHub Pages.

How has this been tested?

• Verified that the GitHub Actions workflow runs without errors and deploys the documentation to the gh-pages branch.
• Checked that the generated documentation appears correctly on GitHub Pages.
• Verified that the deployment works with updates to the documentation.

Checklist

• Prepare Your Sphinx Documentation
• Create the gh-pages Branch
• Configure Automated Deployment via GitHub Actions
• Add the Custom Subdomain
• Configure DNS to point to etalk.eventyay.com
• Verify the Deployment

Summary by Sourcery

Set up a GitHub Actions workflow to automatically deploy the Sphinx documentation to GitHub Pages on every push to the "deployment" branch.

CI:

• Add a GitHub Actions workflow to deploy the Sphinx documentation to GitHub Pages.

Documentation:

• Deploy the generated documentation to GitHub Pages, ensuring the latest documentation is always available.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request automates the deployment of Sphinx documentation to GitHub Pages using GitHub Actions. It addresses issue #256 by setting up a workflow that deploys the documentation on every push to the "deployment" branch.

Sequence diagram for automated Sphinx documentation deployment

sequenceDiagram
    participant D as Developer
    participant GH as GitHub Repository
    participant GA as GitHub Actions
    participant GP as GitHub Pages

    D->>GH: Push changes to deployment branch
    GH->>GA: Trigger workflow
    GA->>GA: Check out repository
    GA->>GA: Set up Python
    GA->>GA: Install dependencies
    GA->>GA: Build Sphinx documentation
    GA->>GP: Deploy to gh-pages branch
    GP->>GP: Update documentation site

Loading

File-Level Changes

Change	Details	Files
Set up a GitHub Actions workflow to automatically deploy the documentation.	Created a new workflow file named deploy.yml. Configured the workflow to trigger on pushes to the deployment branch. Added steps to install dependencies, build the documentation using make html, and deploy it to gh-pages using peaceiris/actions-gh-pages@v3.	.github/workflows/deploy.yml
Added a CNAME file.	Created a CNAME file, likely to configure a custom domain for the documentation.	CNAME

Possibly linked issues

• Deploy the documentation automatically to the branch gh-pages and Actions #256: The PR addresses the issue by automating the deployment of Sphinx documentation to the gh-pages branch using GitHub Actions.

---

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:

• The workflow is configured to run on the 'deployment' branch - consider targeting your default branch (usually 'main' or 'master') instead, unless there's a specific reason for using a separate deployment branch.

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]

Hi @r3yc0n1c Thanks for the PR. Please check why the Build Packaging checks are failing. They work before this PR.