chore(docs): upgrade sphinx#130
Merged
Merged
Conversation
b6c05ee to
062291f
Compare
Contributor
|
Do you have any idea why this code block changes the rendered output to this? |
Contributor
Author
|
@mwtoews good catch. changed. |
sgillies
reviewed
Mar 4, 2026
use numpy doc style fix minor warnings
There was a problem hiding this comment.
Pull request overview
This PR updates the project’s documentation toolchain/configuration to support a Sphinx upgrade and to render docs using NumPy-style docstrings/directives.
Changes:
- Upgrades the docs dependency to a newer Sphinx version.
- Updates docstring/README reST markup to use explicit
.. code-block::directives. - Adjusts Sphinx/Read the Docs configuration (extensions, exclusions, build image, install method).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
src/affine/__init__.py |
Tweaks the Affine class docstring to be more NumPy-style and uses code-block for the matrix example. |
docs/src/conf.py |
Updates Sphinx config: extensions, exclude patterns, and copyright metadata. |
docs/requirements.txt |
Pins docs build Sphinx version to the upgraded release. |
README.rst |
Replaces a literal block (::) with an explicit code-block directive for the matrix example. |
.readthedocs.yaml |
Updates RTD build OS/Python version and installs the package via pip during doc builds. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
sgillies
approved these changes
Mar 4, 2026
Member
|
Re-ran the failed docs build and it passed. Merging. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Changes