0.7.0
Documenteer provides a new Sphinx configuration profile for general Rubin user guide projects, documenteer.conf.guide
. This configuration profile features the new pydata-sphinx-theme, with customizations based on design tokens from the Rubin Style Dictionary. Most metadata and Sphinx configurations can also be set through a documenteer.toml
file, located alongside the standard Sphinx conf.py
file. Install documenteer[guide]
with pip
to get the dependencies needed for this Sphinx configuration.
Additional packaging updates:
- Documenteer now uses
pyproject.toml
for its packaging. - The GitHub Actions workflows now use SQuaRE composite workflows for many steps.
- The README and change log are now written in Markdown.
- Sphinx version 5 is now included in the test matrix.
What's Changed
- DM-35900: Update flake8 linter by @jonathansick in #124
- DM-35970: Update packaging based on SQuaRE template by @jonathansick in #125
- DM-35917: Protect imports against CmdLineTask not being available by @timj in #126
- DM-35969: Adopt the pydata-sphinx-theme by @jonathansick in #129
- [neophile] Update dependencies by @sqrbot in #131
- DM-36085: Implement a documenteer.toml file for customizing Sphinx user guide configurations by @jonathansick in #130
- DM-36117: Support sphinx.rst_epilog_file in documenteer.toml by @jonathansick in #132
- DM-36137: Support setting extensions, linkcheck and nitpick settings in documenteer.toml by @jonathansick in #133
- DM-36156: Exclude click and autoprogram from guide config by @jonathansick in #134
- DM-36190: Enable additional features and configurations for user guides by @jonathansick in #135
- DM-36213: Additional documentation for user guides by @jonathansick in #136
- DM-36259: Include mermaid in the user guide extensions by @jonathansick in #137
- Fix issues in the ci-cron workflow by @jonathansick in #138
- DM-36351: Add support for sphinxext.opengraph by @jonathansick in #139
- [neophile] Update dependencies by @sqrbot in #140
- DM-36665: Improve readability of documentation by @jonathansick in #141
New Contributors
Full Changelog: 0.6.13...0.7.0