Skip to content

chore(docs): upgrade sphinx#130

Merged
sgillies merged 1 commit into
rasterio:mainfrom
Rotzbua:chore_docs
Mar 4, 2026
Merged

chore(docs): upgrade sphinx#130
sgillies merged 1 commit into
rasterio:mainfrom
Rotzbua:chore_docs

Conversation

@Rotzbua

@Rotzbua Rotzbua commented Jan 4, 2026

Copy link
Copy Markdown
Contributor

Changes

  • upgrade sphinx
  • use numpy doc style

@Rotzbua Rotzbua force-pushed the chore_docs branch 3 times, most recently from b6c05ee to 062291f Compare January 4, 2026 15:03
@mwtoews

mwtoews commented Jan 4, 2026

Copy link
Copy Markdown
Contributor

Do you have any idea why this code block changes the rendered output to this?
image
Maybe it needs .. code-block:: none?

@Rotzbua

Rotzbua commented Jan 5, 2026

Copy link
Copy Markdown
Contributor Author

@mwtoews good catch. changed.

Comment thread docs/src/conf.py Outdated
use numpy  doc style
fix minor warnings
Copilot AI review requested due to automatic review settings March 4, 2026 17:11

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.

Comment thread docs/src/conf.py
Comment thread src/affine/__init__.py
Comment thread .readthedocs.yaml
@sgillies

sgillies commented Mar 4, 2026

Copy link
Copy Markdown
Member

Re-ran the failed docs build and it passed. Merging.

@sgillies sgillies merged commit b076564 into rasterio:main Mar 4, 2026
11 of 12 checks passed
@Rotzbua Rotzbua deleted the chore_docs branch March 5, 2026 08:26
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.

4 participants