Skip to content

Commit 5cd9a52

Browse files
authored
Merge pull request #214 from lsst-sqre/tickets/DM-42705
Update to technote 0.7
2 parents fc31696 + 8c25454 commit 5cd9a52

File tree

4 files changed

+17
-3
lines changed

4 files changed

+17
-3
lines changed

CHANGELOG.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,18 @@
22

33
<!-- scriv-insert-here -->
44

5+
<a id='changelog-1.1.0'></a>
6+
## 1.1.0 (2024-01-30)
7+
8+
### New features
9+
10+
- Update to Technote 0.7.0.
11+
- Add `sphinx_design` as a default extension for technotes.
12+
13+
### Bug fixes
14+
15+
- 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.
16+
517
<a id='changelog-1.0.1'></a>
618
## 1.0.1 (2024-01-02)
719

pyproject.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,11 @@ pipelines = [
9898
]
9999
technote = [
100100
# Theme and extensions for technotes
101-
"technote>=0.6.0,<0.7.0",
101+
"technote>=0.7.0,<0.8.0",
102102
"sphinx-prompt",
103103
"sphinxcontrib-mermaid",
104104
"sphinx-diagrams",
105+
"sphinx_design",
105106
]
106107

107108
[project.urls]

src/documenteer/conf/_toml.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,15 +381,15 @@ def version(self) -> Optional[str]:
381381
382382
1. project.version field in ``documenteer.toml``
383383
2. From importlib if the project.python table is set
384-
3. Default is None.
384+
3. Default is "Latest".
385385
"""
386386
if self.conf.project.version is not None:
387387
return self.conf.project.version
388388
elif self.conf.project.python is not None:
389389
# Via pydantic validation we know this works
390390
return get_version(self.conf.project.python.package)
391391
else:
392-
return None
392+
return "Latest"
393393

394394
@property
395395
def rst_epilog_path(self) -> Optional[Path]:

src/documenteer/conf/technote.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@
3131
"sphinx_diagrams",
3232
"sphinxcontrib.mermaid",
3333
"sphinx_prompt",
34+
"sphinx_design",
3435
]
3536
)
3637

0 commit comments

Comments
 (0)