diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e64f32..99fc41f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,18 @@ + +## 1.1.0 (2024-01-30) + +### New features + +- Update to Technote 0.7.0. +- Add `sphinx_design` as a default extension for technotes. + +### Bug fixes + +- If the `version` field in `documenteer.toml` isn't set, and the project isn't a Python package, then the default value is now "Latest." The former default, None, was invalid. + ## 1.0.1 (2024-01-02) diff --git a/pyproject.toml b/pyproject.toml index 5f53379..5bf2815 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -98,10 +98,11 @@ pipelines = [ ] technote = [ # Theme and extensions for technotes - "technote>=0.6.0,<0.7.0", + "technote>=0.7.0,<0.8.0", "sphinx-prompt", "sphinxcontrib-mermaid", "sphinx-diagrams", + "sphinx_design", ] [project.urls] diff --git a/src/documenteer/conf/_toml.py b/src/documenteer/conf/_toml.py index 91c6b9e..15850a0 100644 --- a/src/documenteer/conf/_toml.py +++ b/src/documenteer/conf/_toml.py @@ -381,7 +381,7 @@ def version(self) -> Optional[str]: 1. project.version field in ``documenteer.toml`` 2. From importlib if the project.python table is set - 3. Default is None. + 3. Default is "Latest". """ if self.conf.project.version is not None: return self.conf.project.version @@ -389,7 +389,7 @@ def version(self) -> Optional[str]: # Via pydantic validation we know this works return get_version(self.conf.project.python.package) else: - return None + return "Latest" @property def rst_epilog_path(self) -> Optional[Path]: diff --git a/src/documenteer/conf/technote.py b/src/documenteer/conf/technote.py index af9ebd6..5373bf5 100644 --- a/src/documenteer/conf/technote.py +++ b/src/documenteer/conf/technote.py @@ -31,6 +31,7 @@ "sphinx_diagrams", "sphinxcontrib.mermaid", "sphinx_prompt", + "sphinx_design", ] )