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

Lock docs dependencies; build docs with recent Sphinx version #938

Merged
merged 1 commit into from
Jun 1, 2023
Merged

Lock docs dependencies; build docs with recent Sphinx version #938

merged 1 commit into from
Jun 1, 2023

Commits on May 31, 2023

  1. Lock docs dependencies; build docs with recent Sphinx version 

    I noticed that my local build of the docs was significantly different
from the ReadTheDocs one, so I wanted to get them in sync.

Per https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html,
this updates the .readthedocs.yaml config for the latest format, pins
the dependency versions (transitively).

To do the transitive pinning, use a requirements.in (which should be
updated by hand) that generates a fully-pinned requirements.txt (which
shouldn't be edited). Added the docs/update_requirements.sh script to
do this.

Now that we're on a recent Sphinx version, we need to use
autodoc_typehints='signature' to avoid the extra empty "Parameters"
sections on all classes.
    @benhoyt
    benhoyt committed May 31, 2023
    Configuration menu
    Copy the full SHA
    fab4c13 View commit details
    Browse the repository at this point in the history