Doc configuration updates #286
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This updates some numpydoc options and ignores inherited members for classes that inherit from IntEnum. IntEnum use throws warnings for sphinx references, so ignore those here for now.
We now have PRs being built in ReadTheDocs, so no need to upload the docs here as well.
greglucas
added
the
Repo: Documentation
bourque
reviewed
Nov 28, 2023
Comment on lines
-29
to
-58
| make -C docs html SPHINXOPTS="-W --keep-going -n" | ||
|
|
||
| - uses: actions/upload-artifact@v2 | ||
| with: | ||
| name: DocumentationHTML | ||
| path: docs/build/html/ | ||
|
|
||
| # Publish built docs to gh-pages branch | ||
| - name: Commit documentation changes | ||
| # push docs only when a GitHub Release is made | ||
| if: github.event_name == 'release' && github.event.action == 'published' | ||
| run: | | ||
| git clone https://github.com/IMAP-Science-Operations-Center/imap_processing.git --branch gh-pages --single-branch gh-pages | ||
| cp -r docs/build/html/* gh-pages/ | ||
| cd gh-pages | ||
| git config --local user.email "action@github.com" | ||
| git config --local user.name "GitHub Action" | ||
| git add . | ||
| git commit -m "Update documentation" -a || true | ||
| # The above command will fail if no changes were present, so we ignore that. | ||
|
|
||
| - name: Publish docs | ||
| # push docs only when a GitHub Release is made | ||
| if: github.event_name == 'release' && github.event.action == 'published' | ||
|
|
||
| uses: ad-m/github-push-action@master | ||
| with: | ||
| branch: gh-pages | ||
| directory: gh-pages | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} |
There was a problem hiding this comment.
I am guessing we are removing all of this because we don't use GitHub pages now that we are using RTD?
There was a problem hiding this comment.
Exactly, this was so you could download and the artifacts created, but much easier to just look at the read the docs built PR pages instead now that we have that set up.
greglucas
merged commit c20b1e8
into
IMAP-Science-Operations-Center:dev
14 checks passed
laspsandoval
pushed a commit
to laspsandoval/imap_processing
that referenced
this pull request
Apr 2, 2024
…doc-conf Doc configuration updates
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change Summary
In #271 we identified that we had to build documentation on Python 3.10 or lower due to IntEnum inheritance. Instead of pinning the lower Python version, we can instead ignore the places that cause the issues directly with numpydoc and
nitpick_ignoreoptions.https://numpydoc.readthedocs.io/en/latest/install.html
The inherited methods are
to_bytes()and the like from theIntclass, which we don't really need/want to show up anyways. They still show up in the documentation, they just aren't clickable.Additionally, put the
nitpicky = Trueinto the configuration, so that anyone building the docs gets that locally as well.closes #271