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.

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

Sphinx API docs improvements #1937

Merged
merged 4 commits into from
Aug 8, 2023
Merged

Sphinx API docs improvements #1937

merged 4 commits into from
Aug 8, 2023

Conversation

Kami
Copy link
Member

@Kami Kami commented Aug 8, 2023

This pull request includes the following sphinx API docs improvements:

  • Move api docs generation from tox file to sphinix config. This seems to be the preferred method. It allows us to re-use the same tox target locally and on CI and it also simplifies RTD approach.
  • Update sphinx-apidocs options to generate separate file for each modules. This makes linking to docs for a specific module easier.
  • Update sphinx-apidocs options to exclude test modules from the api docs.

Those changes should also drastically speed up the docs build time on ReadTheDocs (down to ~200 seconds from ~700 seconds).

preferred approach.

This way we can can re-use the same tox target for CI and simplify our
config.

Also update api docs config to use separate files for easier linking and
exclude test modules and packages from api docs.
@codecov-commenter
Copy link

codecov-commenter commented Aug 8, 2023

Codecov Report

Merging #1937 (d7f0a8b) into trunk (794818c) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##            trunk    #1937   +/-   ##
=======================================
  Coverage   83.18%   83.18%           
=======================================
  Files         352      352           
  Lines       81329    81329           
  Branches     8579     8579           
=======================================
  Hits        67652    67652           
  Misses      10873    10873           
  Partials     2804     2804           

@Kami Kami merged commit 71163d7 into trunk Aug 8, 2023
18 checks passed
@Kami Kami deleted the apidocs_improvements branch August 8, 2023 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants