Skip to content

Commit 914f13a

Browse files
authored
fix: rtd needs the static dir in config & specific location of output html + dev container (#72)
* fix: rtd needs the static dir in config * fix: rtd file location * Dev container * changelog * Fix: labels in dependabot
1 parent 36a3197 commit 914f13a

File tree

5 files changed

+37
-39
lines changed

5 files changed

+37
-39
lines changed

.devcontainer/devcontainer.json

Lines changed: 25 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,29 @@
11
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
2-
// README at: https://github.com/devcontainers/templates/tree/main/src/miniconda
2+
// README at: https://github.com/devcontainers/templates/tree/main/src/python
33
{
4-
"name": "Miniconda (Python 3)",
5-
"image": "mcr.microsoft.com/devcontainers/miniconda:0-3",
6-
4+
"name": "Python 3",
5+
// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
6+
"image": "mcr.microsoft.com/devcontainers/python:3.12",
77
"features": {
8-
"ghcr.io/devcontainers-contrib/features/hatch:2": {},
9-
"ghcr.io/rocker-org/devcontainer-features/quarto-cli:1": {
10-
"installTinyTex": true,
11-
"installChromium": true,
12-
"version": "latest"
13-
}
8+
"ghcr.io/devcontainers-extra/features/copier:7.0.15": {
9+
"version": "9.10.2"
10+
},
11+
"ghcr.io/devcontainers-extra/features/hatch:2.0.18": {
12+
"version": "1.14.2"
13+
},
14+
"ghcr.io/devcontainers-extra/features/pre-commit:2.0.18": {
15+
"version": "4.3.0"
16+
},
17+
"ghcr.io/devcontainers-extra/features/black:2.0.18": {
18+
"version": "25.9.0"
19+
},
20+
"ghcr.io/devcontainers-extra/features/isort:2.0.18": {
21+
"version": "6.0.1"
22+
},
23+
"ghcr.io/va-h/devcontainers-features/uv:1": {
24+
"version": "0.8.22"
25+
},
1426
},
15-
"customizations": {
16-
"vscode": {
17-
"extensions": [
18-
"njpwerner.autodocstring",
19-
"ms-python.python"
20-
],
21-
"settings": {
22-
"autoDocstring.docstringFormat": "numpy"
23-
}
24-
}
25-
}
26-
27-
// Features to add to the dev container. More info: https://containers.dev/features.
28-
// "features": {},
29-
30-
// Use 'forwardPorts' to make a list of ports inside the container available locally.
31-
// "forwardPorts": [],
32-
33-
// Use 'postCreateCommand' to run commands after the container is created.
34-
// "postCreateCommand": "python --version",
35-
36-
37-
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
38-
// "remoteUser": "root"
39-
}
27+
"extensions": [
28+
"ms-vscode.live-server",
29+
]

.github/dependabot.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ updates:
77
interval: monthly
88
labels:
99
- security
10-
- dependency-update
1110
commit-message:
1211
prefix: "chore: bump GitHub Actions"
1312
include: "scope"

.readthedocs.yaml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ build:
77
tools:
88
python: "3.12"
99
commands:
10-
- pip install --upgrade pip setuptools wheel
11-
- pip install hatch
12-
- hatch run docs:build
10+
- pip install --upgrade pip
11+
- pip install -e '.[docs]'
12+
# Make sure RTD can find the html output
13+
- sphinx-build -b html docs $READTHEDOCS_OUTPUT/html

changelog.md

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

33
## Unreleased
44

5+
## v0.4
6+
7+
This release fixes many issues with the original template run in "full mode"
8+
9+
* Add: fix ci, linting, docs and tests run docs separately (@lwasser)
10+
* Fix readthedocs build issues fixed by updating .readthedocs.yaml to install docs dependencies and build docs directly & redundant api docs (@lwasser)
11+
* Add: Move to optional-dependency groups and call those groups in hatch envs (@lwasser)
12+
513
## 0.1.12
614

715
* Add: CI based pypi release workflow & dynamic versioning (@lwasser, #32)

docs/_static/.gitkeep

Whitespace-only changes.

0 commit comments

Comments
 (0)