Skip to content

Commit

Permalink
Merge pull request #214 from lsst-sqre/tickets/DM-42705
Browse files Browse the repository at this point in the history
Update to technote 0.7
  • Loading branch information
jonathansick committed Jan 30, 2024
2 parents fc31696 + 8c25454 commit 5cd9a52
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 3 deletions.
12 changes: 12 additions & 0 deletions CHANGELOG.md
Expand Up @@ -2,6 +2,18 @@

<!-- scriv-insert-here -->

<a id='changelog-1.1.0'></a>
## 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.

<a id='changelog-1.0.1'></a>
## 1.0.1 (2024-01-02)

Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions src/documenteer/conf/_toml.py
Expand Up @@ -381,15 +381,15 @@ 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
elif self.conf.project.python is not None:
# 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]:
Expand Down
1 change: 1 addition & 0 deletions src/documenteer/conf/technote.py
Expand Up @@ -31,6 +31,7 @@
"sphinx_diagrams",
"sphinxcontrib.mermaid",
"sphinx_prompt",
"sphinx_design",
]
)

Expand Down

0 comments on commit 5cd9a52

Please sign in to comment.