From e43483358591c1534cc29f0eab634f84082e54f1 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Mon, 29 Jan 2024 16:22:42 -0500 Subject: [PATCH 1/5] Update to technote 0.7 - This version of technote defaults the date_modified metadata to the build time if a date isn't explicitly set. - CSS improvements for code samples without captions --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 5f533797..da4c6c76 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -98,7 +98,7 @@ 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", From 5b89e1e9b87b047274ac1f8d75af7ef80de7b408 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Tue, 30 Jan 2024 17:36:32 -0500 Subject: [PATCH 2/5] Add Sphinx design as a default technote extension This lets up add things like grids, icons, and buttons to technotes (e..g https://sqr-084.lsst.io uses this) --- pyproject.toml | 1 + src/documenteer/conf/technote.py | 1 + 2 files changed, 2 insertions(+) diff --git a/pyproject.toml b/pyproject.toml index da4c6c76..5bf28154 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -102,6 +102,7 @@ technote = [ "sphinx-prompt", "sphinxcontrib-mermaid", "sphinx-diagrams", + "sphinx_design", ] [project.urls] diff --git a/src/documenteer/conf/technote.py b/src/documenteer/conf/technote.py index af9ebd6b..5373bf5e 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", ] ) From b0068419643f7768eb9859bc8f333dad330d33f5 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Tue, 30 Jan 2024 17:43:43 -0500 Subject: [PATCH 3/5] Change default version to "Latest" If a version was not set in the project table, and the project isn't a Python package, then default to a string "Latest" for the Sphinx version. "None" isn't a valid value for Sphinx. --- src/documenteer/conf/_toml.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/documenteer/conf/_toml.py b/src/documenteer/conf/_toml.py index 91c6b9e7..15850a0a 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]: From 6b171f5dc0ffe2a41701b4906db44c43123677a9 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Tue, 30 Jan 2024 17:46:13 -0500 Subject: [PATCH 4/5] Add change log entry --- changelog.d/20240130_174434_jsick_DM_42705.md | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 changelog.d/20240130_174434_jsick_DM_42705.md diff --git a/changelog.d/20240130_174434_jsick_DM_42705.md b/changelog.d/20240130_174434_jsick_DM_42705.md new file mode 100644 index 00000000..7bf4ae8f --- /dev/null +++ b/changelog.d/20240130_174434_jsick_DM_42705.md @@ -0,0 +1,8 @@ +### 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. From 8c25454ec232b4ba0a31540c3c52cb3b7c5bbb90 Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Tue, 30 Jan 2024 17:51:38 -0500 Subject: [PATCH 5/5] Prepare for Documenteer 1.1.0 release --- CHANGELOG.md | 12 ++++++++++++ changelog.d/20240130_174434_jsick_DM_42705.md | 8 -------- 2 files changed, 12 insertions(+), 8 deletions(-) delete mode 100644 changelog.d/20240130_174434_jsick_DM_42705.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 7e64f322..99fc41fd 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/changelog.d/20240130_174434_jsick_DM_42705.md b/changelog.d/20240130_174434_jsick_DM_42705.md deleted file mode 100644 index 7bf4ae8f..00000000 --- a/changelog.d/20240130_174434_jsick_DM_42705.md +++ /dev/null @@ -1,8 +0,0 @@ -### 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.