Fix CNAME gh pages deployment

[r3yc0n1c]

fixes #300

Descripton

• resolved CNAME not being added on the gh-page deployment
• added CNAME

ref. PR #304

Summary by Sourcery

Fixes an issue where the CNAME file was not being included in the GitHub Pages deployment, preventing the correct association with the custom domain. The deployment workflow is updated to copy the CNAME file into the deploy directory during the build process.

Build:

• Adds a CNAME file to the generated documentation to ensure the GitHub Pages deployment is correctly associated with the custom domain.

Deployment:

• Updates the deployment workflow to copy the CNAME file into the deploy directory.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request addresses issue #300 by ensuring the CNAME file is included when deploying the documentation to GitHub Pages. The workflow was updated to copy the CNAME file to the correct directory during the build process. A CNAME file was also added.

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

File-Level Changes

Change	Details	Files
Configured the GitHub Actions workflow to copy the CNAME file to the deployment directory.	Added a step to copy the CNAME file from the docs directory to the docs/_build/html directory. Updated the trigger to include both the development and main branches.	.github/workflows/gh-pages-deploy.yml
Added a CNAME file to the docs directory.	Added a CNAME file.	docs/CNAME

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#300	Automatically deploy Sphinx documentation to the gh-pages branch using Github Actions.	✅
#300	Configure the deployment to work with a custom subdomain (e.g., evideo.eventyay.com) by adding a CNAME file.	✅

---

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 renaming the workflow file to deploy.yml to align with its purpose.
• It might be better to add the CNAME file to the static directory and have it copied as part of the build.

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]

Please also remove CNAME in the root directory.