Skip to content

Commit 5d6e11f

Browse files
committed
fix pdf doc build, make GH releases prereleases
1 parent c9782af commit 5d6e11f

File tree

4 files changed

+22
-6
lines changed

4 files changed

+22
-6
lines changed

.github/workflows/release.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ jobs:
133133
'${{ github.ref_name }}'
134134
--repo '${{ github.repository }}'
135135
--generate-notes
136+
--prerelease
136137
- name: Upload artifact signatures to GitHub Release
137138
env:
138139
GITHUB_TOKEN: ${{ github.token }}

justfile

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ manage *COMMAND:
1414
import os
1515
import sys
1616
from django.core import management
17-
sys.path.append(os.getcwd())
1817
os.environ["DJANGO_SETTINGS_MODULE"] = "tests.settings"
1918
management.execute_from_command_line(sys.argv + "{{ COMMAND }}".split(" "))
2019

@@ -92,9 +91,17 @@ clean: clean-docs clean-env clean-git-ignored
9291
build-docs-html: install-docs
9392
@just run sphinx-build --fresh-env --builder html --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/html
9493

94+
[script]
95+
_open-pdf-docs:
96+
import webbrowser
97+
from pathlib import Path
98+
webbrowser.open(f"file://{Path('./doc/build/pdf/django-render-static.pdf').absolute()}")
99+
95100
# build pdf documentation
96101
build-docs-pdf: install-docs
97-
@just run sphinx-build --fresh-env --builder latexpdf --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/pdf
102+
@just run sphinx-build --fresh-env --builder latex --doctree-dir ./doc/build/doctrees ./doc/source ./doc/build/pdf
103+
make -C ./doc/build/pdf
104+
@just _open-pdf-docs
98105

99106
# build the docs
100107
build-docs: build-docs-html
@@ -212,10 +219,15 @@ validate_version VERSION:
212219
import re
213220
import tomllib
214221
import django_enum
215-
version = re.match(r"v?(\d+[.]\d+[.]\w+)", "{{ VERSION }}").groups()[0]
216-
assert version == tomllib.load(open('pyproject.toml', 'rb'))['project']['version']
217-
assert version == django_enum.__version__
218-
print(version)
222+
from packaging.version import Version
223+
raw_version = "{{ VERSION }}".lstrip("v")
224+
version_obj = Version(raw_version)
225+
# the version should be normalized
226+
assert str(version_obj) == raw_version
227+
# make sure all places the version appears agree
228+
assert raw_version == tomllib.load(open('pyproject.toml', 'rb'))['project']['version']
229+
assert raw_version == django_enum.__version__
230+
print(raw_version)
219231

220232
# issue a relase for the given semver string (e.g. 2.1.0)
221233
release VERSION:

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ dev = [
8686
"matplotlib>=3.9.4",
8787
"mypy>=1.15.0",
8888
"numpy>=2.0.2",
89+
"packaging>=24.2",
8990
"pre-commit>=4.1.0",
9091
"pytest>=8.3.4",
9192
"pytest-cov>=6.0.0",

uv.lock

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)