Add docs build job #1168
Merged
Add docs build job #1168
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
AyodeAwe
added
improvement
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## branch-23.04 #1168 +/- ##
===============================================
Coverage ? 87.99%
===============================================
Files ? 21
Lines ? 483
Branches ? 0
===============================================
Hits ? 425
Misses ? 58
Partials ? 0 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
ajschmidt8
reviewed
Jan 30, 2023
this option is spelled incorrectly and therefore not used by `sphinx`. the correct configuration options are specified in `conf.py`
according to the `autodoc` docs below, `autodoc` will automatically import the modules to be documented. this the docs build CI job installs the packages that were previously built in the workflow run, we don't need to modify `sys.path` to include these packages - https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html
a previous commit updated the `xml` output location for `Doxygen`, so this commit updates the `sphinx` config accordingly
and re-generate dependency files
according to the `sphinx` warnings, these `.rst` files aren't used anywhere
these links were invalid and issuing `sphinx` warnings
|
To do:
|
ajschmidt8
reviewed
Feb 13, 2023
ajschmidt8
approved these changes
Feb 17, 2023
|
/merge |
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.
The PR adds a
docs_buildprocess to the PR and Build workflows for this repository. The generated docs are synced to s3 for only the build workflows.