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.

Sign up for GitHub

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

Jump to bottom

Docs: Minimally modernize Sphinx configuration. Fix building on Python 3.11. #526

Merged
merged 6 commits into from
Oct 23, 2024
Merged

Docs: Minimally modernize Sphinx configuration. Fix building on Python 3.11. #526

merged 6 commits into from
Oct 23, 2024

Conversation

amotl
Copy link
Collaborator

@amotl amotl commented Oct 23, 2024

About

Just a little maintenance patch for the Sphinx docs, to minimally modernize dependencies, and to fix the build 1.

Footnotes

  1. [...] and to probe if any commit styles of mine (commit messages, wording, whatever) need to be adjusted to comply with any policies employed here. ↩

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Oct 23, 2024 •
edited
Loading

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve updates to several documentation files and configuration settings. The .gitignore file now includes a rule to ignore virtual environment directories. The requirements.txt file has been significantly altered, with many dependencies removed and new version constraints applied. The Sphinx configuration file conf.py has been updated to specify English as the documentation language. Additionally, various sections of the documentation have been enhanced for clarity, with updates to examples and references in index.rst, tour.rst, and other documentation files.

Changes

File Path Change Summary
.gitignore Added entry to ignore any virtual environment directories or files starting with .venv.
docs/requirements.txt Removed numerous dependencies; added upper and lower version constraints for several packages: alabaster, jinja2, markupsafe, readme-renderer, sphinx, and sphinxcontrib-websupport.
docs/source/conf.py Updated language setting from None to "en" to specify English for documentation.
docs/source/index.rst Updated build status image link from Travis CI to GitHub Actions; modified reference link for "Two Scoops of Django" to a general link.
docs/source/tour.rst Enhanced various sections with updated examples, including changes to the GreetingResource class, background tasks, OpenAPI schema definitions, interactive documentation, and testing with pytest.

Poem

In the meadow where we hop,
New changes make our hearts stop!
With dependencies now so bright,
Our docs will shine in the light.
Virtual paths are tucked away,
Hooray for updates, hip-hip-hooray! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@amotl amotl mentioned this pull request Oct 23, 2024
Merged
kennethreitz added a commit that referenced this pull request Oct 23, 2024
@kennethreitz
CI: Slightly update GHA configuration, now targeting branch main (#527
a73e413 
)

## Problem
CI did not start on GH-526.

## Details
Also, add a configuration snippet to cancel redundant in-progress jobs,
in order to save resources. That means running jobs are terminated when
subsequently pushing to the same branch / updating the same PR,
DWIM-like.
@kennethreitz kennethreitz marked this pull request as ready for review October 23, 2024 23:30
@amotl amotl mentioned this pull request Oct 23, 2024
Open
@kennethreitz kennethreitz merged commit de08b15 into main Oct 23, 2024
2 checks passed
@kennethreitz kennethreitz deleted the docs-dependencies branch October 23, 2024 23:32
@kennethreitz
Copy link
Owner

✨ 🍰 ✨

amotl
amotl commented Oct 23, 2024
View reviewed changes
docs/source/index.rst
.. _Two Scoops of Django: https://www.twoscoopspress.com/products/two-scoops-of-django-1-11
.. _Two Scoops of Django: https://www.feldroy.com/two-scoops-press#two-scoops-of-django
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Let's add a little workflow invoking make linkcheck?

Copy link
Collaborator Author

@amotl amotl Oct 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

... too late, merged already ;]. Next time!

Copy link
Owner

Choose a reason for hiding this comment

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

@amotl that's a good idea

@kennethreitz
Copy link
Owner

oh sorry!

@kennethreitz
Copy link
Owner

Sorry, it's been a while since I've done this :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kennethreitz kennethreitz Awaiting requested review from kennethreitz

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@amotl @kennethreitz