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: fix sphinx nitpicky issues #2036

Merged
merged 2 commits into from
Jul 18, 2022
Merged

docs: fix sphinx nitpicky issues #2036

merged 2 commits into from
Jul 18, 2022

Commits on Jul 18, 2022

  1. docs: fix sphinx nitpicky issues 

    Enable nitpicky mode for Sphinx and fix all warnings and errors
that occur when running with nitpicky enabled.

Other changes:
- Add a tox environment for building docs (-docs). This is so we can
  test building docs on various versions of python as there seems to be
  some differences in warnings between different versions. This tox
  environment is enabled for linux CI builds.
- Change readthedocs to use python 3.9 as earlier versions do not handle
  `@typing.overload` with type aliases.
- Fixes #1878
    @aucampia
    aucampia committed Jul 18, 2022
    Configuration menu
    Copy the full SHA
    5ceebab View commit details
    Browse the repository at this point in the history

  2. docs: fix typo

    @aucampia
    aucampia committed Jul 18, 2022
    Configuration menu
    Copy the full SHA
    c8c4767 View commit details
    Browse the repository at this point in the history