Skip to content

Releases: lsst-sqre/documenteer

1.0.0a3

07 Jul 20:20
227c483
Compare
Choose a tag to compare
1.0.0a3 Pre-release
Pre-release

What's Changed

Full Changelog: 1.0.0a2...1.0.0a3

1.0.0a2

05 Jul 22:26
5227e84
Compare
Choose a tag to compare
1.0.0a2 Pre-release
Pre-release

What's Changed

Full Changelog: 1.0.0a1...1.0.0a2

0.8.3

03 Jul 20:16
d6f6e25
Compare
Choose a tag to compare

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

Full Changelog: 0.8.2...0.8.3

0.8.2

27 Jun 19:57
1e841fa
Compare
Choose a tag to compare

Fixes

  • Fix package-docs ctx object lookup bug introduced in 0.8.1 release.

What's Changed

Full Changelog: 0.8.1...0.8.2

0.8.1

27 Jun 19:14
6d0f7ff
Compare
Choose a tag to compare

Fixes

  • Fixed a bug in the in the help subcommand for the package-docs and stack-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

23 Jun 18:01
e25bb26
Compare
Choose a tag to compare

New features:

  • Added a -W / --warning-is-error flag to the package-docs build and stack-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 with sphinx-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

07 Jun 19:08
d99802c
Compare
Choose a tag to compare
1.0.0a1 Pre-release
Pre-release
  • 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 in documenteer.toml can be used to configure both the documenteer.ext.openapi and sphinxcontrib-redoc extensions. sphinxcontrib-redoc is installed and configured by default for all Rubin user guide projects (projects that use documenteer.conf.guide).

What's Changed

Full Changelog: 0.8.0b2...1.0.0a1

0.7.5

07 Jun 18:47
a9a96ee
Compare
Choose a tag to compare

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

Full Changelog: 0.7.4...0.7.5

0.7.4

16 May 19:50
86f7e32
Compare
Choose a tag to compare

Fixes:

  • Pinned Sphinx < 7 for the pipelines and technote extras since their themes are not currently compatible with Sphinx 7 and later.

What's Changed

Full Changelog: 0.7.3...0.7.4

0.7.3

20 Mar 22:31
0a24725
Compare
Choose a tag to compare

Fixes:

  • Add requirements.txt and .venv/venv to the default exclude_patterns for User Guides.

What's Changed

Full Changelog: 0.7.2...0.7.3