Skip to content

Commit fc840ac

Browse files
committed
add readthedocs config and project urls
1 parent 3866eaf commit fc840ac

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

.readthedocs.yaml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
2+
3+
# Read the Docs configuration file
4+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
5+
6+
# Required
7+
version: 2
8+
9+
# Set the OS, Python version, and other tools you might need
10+
build:
11+
os: ubuntu-24.04
12+
tools:
13+
python: "3.13"
14+
jobs:
15+
post_checkout:
16+
- git fetch --unshallow || true
17+
- git config remote.origin.fetch '+refs/heads/*:refs/remotes/origin/*' || true
18+
- git fetch --all --tags || true
19+
create_environment:
20+
- asdf plugin add uv
21+
- asdf install uv 0.9.2
22+
- asdf global uv 0.9.2
23+
install:
24+
- uv sync --extra api --extra celery --extra hsm --no-default-groups --group dev --group docs
25+
pre_build:
26+
- uv run make -C docs extra-files
27+
build:
28+
html:
29+
- uv run sphinx-build -T -b html docs/ $READTHEDOCS_OUTPUT/html
30+
31+
# Build documentation in the "docs/" directory with Sphinx
32+
sphinx:
33+
configuration: docs/conf.py
34+
35+
# Optionally, but recommended,
36+
# declare the Python requirements required to build your documentation
37+
# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
38+
# python:
39+
# install:
40+
# - requirements: docs/requirements.txt
41+
42+
43+

docs/changelog.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
#########
2+
ChangeLog
3+
#########
4+
5+
***********
6+
0.1.0 (TBR)
7+
***********
8+
9+
Initial version.

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,13 @@ dynamic = ["version"]
3737
[project.scripts]
3838
structured-tutorial = "structured_tutorials.cli:main"
3939

40+
[project.urls]
41+
Homepage = "https://github.com/mathiasertl/django-ca/"
42+
Documentation = "https://django-ca.readthedocs.io/"
43+
Source = "https://github.com/mathiasertl/structured-tutorials"
44+
Issues = "https://github.com/mathiasertl/structured-tutorials/issues"
45+
Changelog = "https://django-ca.readthedocs.io/en/latest/changelog.html"
46+
4047
[tool.coverage.run]
4148
source = [
4249
"structured_tutorials",

0 commit comments

Comments
 (0)