DM-45803: Remove pipelines.lsst.io-related extensions and configuration #229
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 code will be migrated to https://github.com/lsst-dm/sphinxutils to support pipelines.lsst.io builds. This is only used for the pipelines doc build commands
These will be migrated to sphinxutils in https://github.com/lsst-dm/sphinxutils to support pipelines.lsst.io builds.
These extensions will be migrated to sphinxutils (https://github.com/lsst-dm/sphinxutils) to directly support pipelines.lsst.io builds where this extension is used.
These were only used by pipelines-related extensions, so we don't need to support this module here.
Adds mypy configuration that requires typed definitions and adds typing to code. Note that some of the tests for extensions use some odd, maybe ancient practices. I've disabled type checking those tests since adding types isn't practical right now. I should probably re-do those tests with a Sphinx project root and analyze the out HTML for correctness.
This documentation will move to sphinxutils in https://github.com/lsst-dm/sphinxutils
Originally from Gafaelfawr; https://github.com/lsst-sqre/gafaelfawr/blob/main/docs/_templates/autosummary_core/pydantic_model.rst This template ensures that we don't document inherited members from the Pydantic BaseModel. We benefit from autodoc_pydantic in two ways. First, it provides a better presentation of Pydantic models. Second, in conjunction with the custom automodapi template, we can avoid a lot of API linking errors by omitting the base methods from BaseModel in the API docs for a model.
These nitpick ignore rules come up in a lot of SQuaRE projects in order to avoid API referenincing issues to Pydantic, FastAPI, and similar docs that don't publish intersphinx inventories.
This should make the template available to all user guide projects by default. In doing so, we're adding autodoc_pydantic as a default dependency for all Rubin user guide projects.
This ensures that existing API docs are cleaned up, which solves issues when refactoring the codebase.
This template is originally from Gafaelfawr. It ensures that exception definitions show inheritance in their class documentation. https://github.com/lsst-sqre/gafaelfawr/blob/main/docs/_templates/autosummary_core/exception.rst
jonathansick
force-pushed
the
tickets/DM-45803
branch
from
fb4d062 to
45f836f
Compare
This adds the ruff configuration, which is based on SQuaRE's common ruff-shared.toml file in https://github.com/lsst/templates.
- Drop the neophile update workflow, since we'll just apply these changes whenever we work on Documenteer. - Use the PYTHON_VERSION environment variable pattern to dry out setting the default Python version for a workflow.
The Sphinx path class is now deprecated.
jonathansick
force-pushed
the
tickets/DM-45803
branch
from
a799fa3 to
542b017
Compare
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.
Sphinx configurations and extensions specific to pipelines.lsst.io will move to
https://github.com/lsst-dm/sphinxutils This cleans up Documenteer so that sphinxutils will be able to build upon Documenteer. This will be part of a major release of Documenteer that breaks backwards compatibility by removing pipelines-related code.