Releases: lsst-sqre/documenteer
Releases · lsst-sqre/documenteer
1.0.0a3
What's Changed
- DM-39837: Try DM-39837 version of pypi-publish action by @jonathansick in #173
Full Changelog: 1.0.0a2...1.0.0a3
1.0.0a2
What's Changed
- DM-39580: Document import of get_openapi by @jonathansick in #162
- Fix typos on README by @jonathansick in #165
- [neophile] Update dependencies by @sqrbot in #163
- DM-25337: Add -W (warnings as errors) and
-n
nitpicky mode for stack-docs / package-docs build by @jonathansick in #167 - DM-39884: Pin pydantic < 2.0.0 by @jonathansick in #172
Full Changelog: 1.0.0a1...1.0.0a2
0.8.3
Fixes:
- Pin Pydantic < 2.0.0. This is a temporary measure while we add and test compatibility with Pydantic 1 and 2.
What's Changed
- DM-39884: Pin Pydantic < 2 (0.8.3 release) by @jonathansick in #171
Full Changelog: 0.8.2...0.8.3
0.8.2
Fixes
- Fix package-docs ctx object lookup bug introduced in 0.8.1 release.
What's Changed
- DM-25337: Fix bug in package-docs ctx lookup by @jonathansick in #170
Full Changelog: 0.8.1...0.8.2
0.8.1
Fixes
- Fixed a bug in the in the
help
subcommand for thepackage-docs
andstack-docs
commands.
What's Changed
- DM-25337: Fix stack-docs/package-docs help command (0.8.1 release) by @jonathansick in #168
Full Changelog: 0.8.0...0.8.1
0.8.0
New features:
- Added a
-W
/--warning-is-error
flag to thepackage-docs build
andstack-docs build
commands for Science Pipelines documentation builds. This flag causes Sphinx to treat warnings as errors, which is useful for CI builds.
Fixes:
- Pinned
sphinx-autodoc-typehints<1.23.0
to avoid a Sphinx version conflict withsphinx-design
. The former required Sphinx >= 7.
What's Changed
- DM-37783: Add -W flag to package-docs build / stack-docs build by @jonathansick in #164
Full Changelog: 0.7.5...0.8.0
1.0.0a1
- Use sphinxcontrib-jquery to ensure jQuery is available for user guide and Pipelines documentation builds.
- New support for embedding OpenAPI documentation in a Redoc-generated subsite. The
documenteer.ext.openapi
extension can call a user-specified function to generate and install the OpenAPI specification the Sphinx source. For user guide projects, the[project.openapi]
table indocumenteer.toml
can be used to configure both thedocumenteer.ext.openapi
andsphinxcontrib-redoc
extensions. sphinxcontrib-redoc is installed and configured by default for all Rubin user guide projects (projects that usedocumenteer.conf.guide
).
What's Changed
- [neophile] Update dependencies by @sqrbot in #147
- DM-38388: Improve source exclusions for user guides by @jonathansick in #155
- [neophile] Update dependencies by @sqrbot in #157
- DM-37525: Add openapi generator extension by @jonathansick in #159
- DM-39580: Add sphinxcontrib-jquery by @jonathansick in #161
Full Changelog: 0.8.0b2...1.0.0a1
0.7.5
Fixes:
- Use sphinxcontrib-jquery to ensure jQuery is available for user guide and Pipelines documentation builds. Sphinx 6 dropped jQuery from its default theme, and the new pydata-sphinx-theme v0.12 does not include it either.
What's Changed
- DM-39580: Add sphinxcontrib-jquery (0.7 backport) by @jonathansick in #160
Full Changelog: 0.7.4...0.7.5
0.7.4
Fixes:
- Pinned Sphinx < 7 for the
pipelines
andtechnote
extras since their themes are not currently compatible with Sphinx 7 and later.
What's Changed
- Pin Sphinx < 7 for pipelines, technote by @jonathansick in #158
Full Changelog: 0.7.3...0.7.4
0.7.3
Fixes:
- Add
requirements.txt
and.venv
/venv
to the defaultexclude_patterns
for User Guides.
What's Changed
- DM-38388: Backport for 0.7 by @jonathansick in #156
Full Changelog: 0.7.2...0.7.3