Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

readthedocs.io configuration for ducumentation updates #562

Merged
merged 1 commit into from
Sep 19, 2024

Conversation

monocongo
Copy link
Owner

@monocongo monocongo commented Sep 19, 2024

New configuration for readthedocs.io

Summary by Sourcery

Add a Read the Docs configuration file to set up the documentation build environment using Sphinx, specifying the OS, Python version, and other potential tools.

Build:

  • Add a Read the Docs configuration file to specify the build environment and tools for documentation.

Documentation:

  • Configure Sphinx to build documentation in the 'docs/' directory using a new Read the Docs configuration file.

@monocongo monocongo self-assigned this Sep 19, 2024
Copy link

sourcery-ai bot commented Sep 19, 2024

Reviewer's Guide by Sourcery

This pull request adds a new configuration file for Read the Docs (readthedocs.io) to set up the documentation build process. The configuration specifies the build environment, Python version, and Sphinx settings for generating the project's documentation.

File-Level Changes

Change Details Files
Added a new Read the Docs configuration file
  • Specified Ubuntu 22.04 as the build OS
  • Set Python version to 3.12
  • Configured Sphinx to use docs/conf.py
  • Added commented-out options for additional tools, builders, and formats
  • Included commented-out section for specifying Python requirements
docs/.readthedocs.yaml

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

sonarcloud bot commented Sep 19, 2024

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @monocongo - I've reviewed your changes and they look great!

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 ✨
Help me be more useful! Please click 👍 or 👎 on each comment to tell me if it was helpful.

@monocongo monocongo merged commit 9876d8d into master Sep 19, 2024
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant