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

Conversation

aucampia
Copy link
Member

@aucampia aucampia commented Jul 18, 2022 •
edited
Loading

Summary of changes

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 6.1.1: sphinx warnings reference target not found #1878

Checklist

  • Checked that there aren't other open pull requests for
    the same change.
  • Added tests for any changes that have a runtime impact.
  • Checked that all tests and type checking passes.
  • For changes that have a potential impact on users of this project:
    • Considered updating our changelog (CHANGELOG.md).
  • Considered granting push permissions to the PR branch,
    so maintainers can fix minor issues and keep your PR up to date.

@aucampia aucampia linked an issue Jul 18, 2022 that may be closed by this pull request
6.1.1: sphinx warnings reference target not found #1878
Closed
@aucampia aucampia mentioned this pull request Jul 18, 2022
Closed
@aucampia aucampia force-pushed the iwana-20220718T0258-sphinx-nitpick branch from acfc956 to 7c13de4 Compare July 18, 2022 01:13
@coveralls
Copy link

coveralls commented Jul 18, 2022 •
edited
Loading

Coverage Status

Coverage increased (+0.0005%) to 90.446% when pulling c8c4767 on iwana-20220718T0258-sphinx-nitpick into 63ff76c on master.

@aucampia aucampia force-pushed the iwana-20220718T0258-sphinx-nitpick branch 2 times, most recently from 06352b0 to 4536cc5 Compare July 18, 2022 03:46
@aucampia aucampia marked this pull request as ready for review July 18, 2022 03:53
@aucampia
docs: fix sphinx nitpicky issues
5ceebab 
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 force-pushed the iwana-20220718T0258-sphinx-nitpick branch from 4536cc5 to 5ceebab Compare July 18, 2022 12:39
@aucampia aucampia requested a review from a team July 18, 2022 12:41
ghost
ghost approved these changes Jul 18, 2022
View reviewed changes
Copy link

@ghost ghost left a comment

Choose a reason for hiding this comment

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

lgtm

@aucampia aucampia merged commit 0d413fd into master Jul 18, 2022
@aucampia aucampia deleted the iwana-20220718T0258-sphinx-nitpick branch July 18, 2022 20:26
This was referenced Jul 20, 2022
Closed
Closed
Open
This was referenced Aug 21, 2022
Open
Closed
Open
This was referenced Aug 31, 2022
Open
Closed
This was referenced Sep 16, 2022
Open
Closed
Closed
This was referenced Sep 28, 2022
Open
Open
@kloczek kloczek mentioned this pull request Oct 7, 2022
Open
@kloczek kloczek mentioned this pull request Dec 3, 2022
Open
@kloczek kloczek mentioned this pull request Dec 12, 2022
Closed
@kloczek kloczek mentioned this pull request Sep 4, 2023
Open
This was referenced Nov 5, 2023
Closed
Open
This was referenced Nov 18, 2023
Open
Closed
@kloczek kloczek mentioned this pull request Nov 29, 2023
Open
This was referenced Dec 30, 2023
Open
Open
@kloczek kloczek mentioned this pull request Jan 11, 2024
Closed
This was referenced Feb 5, 2024
Closed
Open
Closed
This was referenced Feb 15, 2024
Open
Closed
Open
This was referenced Mar 13, 2024
Open
Open
Open
Open
@kloczek kloczek mentioned this pull request Mar 23, 2024
Open
This was referenced Mar 31, 2024
Closed
Open
Closed
Open
This was referenced May 17, 2024
Open
Open
This was referenced May 27, 2024
Open
Open
Open
@kloczek kloczek mentioned this pull request Jul 2, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

6.1.1: sphinx warnings reference target not found
2 participants
@aucampia @coveralls