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

Add options for partial documentation builds #368

Merged
merged 9 commits into from
Feb 2, 2024

Conversation

greschd
Copy link
Member

@greschd greschd commented Feb 2, 2024

Add the following options to run a partial doc build, controlled
via environment variables:

  • PYACP_DOC_SKIP_GALLERY=true: do not build the examples
    gallery
  • PYACP_DOC_SKIP_API=true: do not build the API reference

Add a quick variant of the documentation build in CI which only
builds the main pages (no API / examples). This build runs in parallel
with the full documentation build, to provider quicker feedback
on errors.

Add docstrings to the enum classes.

@greschd greschd changed the title Improve doc build times in CI Enable skipping examples in doc build, add enum docstrings Feb 2, 2024
@greschd greschd force-pushed the maint/improve_ci_doc_build_times branch from 558d089 to b1bcd8b Compare February 2, 2024 09:41
* Add parallel quick doc build to CI

* Skip API doc in quick doc build

* Improve quick / full doc build distinction
@greschd greschd changed the title Enable skipping examples in doc build, add enum docstrings Add options for partial documentation builds Feb 2, 2024
@greschd greschd marked this pull request as ready for review February 2, 2024 10:23
@greschd
Copy link
Member Author

greschd commented Feb 2, 2024

Note 1: the expected checks in the branch protection will need to be updated.

Note 2: we could also add builds that run only the examples / API separately.

Note 3: I originally tried to improve doc build speeds in CI by switching to a theme
that doesn't create separate pages for attributes, but this caused some warnings
that I couldn't easily resolve.

@greschd greschd enabled auto-merge (squash) February 2, 2024 13:14
@greschd greschd merged commit 6961ca0 into main Feb 2, 2024
10 checks passed
@greschd greschd deleted the maint/improve_ci_doc_build_times branch February 2, 2024 13:38
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.

2 participants