DM-28326: Adopt Documenteer 0.6 configuration system #168
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
No longer needed with Documenteer inside the Rubin Conda environment (RFC-733).
Travis is no longer needed; moving to GitHub Actions to provide the check for PRs.
This will be useful for setting up branch protections to ensure the branch is up-to-date. However, hopefully we can add more useful linting in the future.
jonathansick
force-pushed
the
tickets/DM-28326
branch
from
9c11c67 to
ce4dfe9
Compare
Undo the automodapi autodoc enhancements that are incompatible with pybind11 properties. Essentially this restores the built-in getattr as the attr getter for "type" rather than https://github.com/astropy/sphinx-automodapi/blob/b68a5f3c6805d7c5d0eaa55fff1ff84cc671baf0/sphinx_automodapi/autodoc_enhancements.py#L15
|
I think merging this will break the Jenkins documenteer build, so it has to be part of the overall switch to building with the stack. I have included it as part of the tickets/DM-28328 branch, which is preparing for that switch. |
|
Closing in favor of #174 |
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.
This PR updates the Sphinx configuration to use the new Documenteer 0.6 configuration APIs, described in https://documenteer.lsst.io/pipelines/configuration.html#sphinx-configuration-for-stack-documentation-projects.
This PR should be tested and merged in conjunction with the RFC-733 and the DM-26671 (rubinenv) and DM-28328 (Jenkins stack-os-matrix update).
Besides the configuration change, this PR also migrates the repo from Travis CI to GitHub Actions for the null check used for GitHub branch protections.