Skip to content

Commit 78ae021

Browse files
SilverRainZopencode[bot]
andcommitted
chore: Update project template to sphinx-notes/cookiecutter@463b120a
Co-authored-by: opencode[bot] <172169224+opencode[bot]@users.noreply.github.com>
1 parent ee7a219 commit 78ae021

7 files changed

Lines changed: 25 additions & 10 deletions

File tree

.cruft.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"template": "https://github.com/sphinx-notes/cookiecutter",
3-
"commit": "233a8daa4e276a9559975a51178f29e7079dcafd",
3+
"commit": "463b120aec3391878cf9453ca26280bf5258c08d",
44
"checkout": null,
55
"context": {
66
"cookiecutter": {

.github/workflows/lint.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
1+
# This file is generated from sphinx-notes/cookiecutter.
2+
13
name: Ruff
24
on: [ push, pull_request ]
35

46
jobs:
57
ruff:
68
runs-on: ubuntu-latest
79
steps:
8-
- uses: actions/checkout@v4
10+
- uses: actions/checkout@v6
911
- uses: chartboost/ruff-action@v1

.github/workflows/pages.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This file is generated from sphinx-notes/cookiecutter.
2+
13
name: Deploy Sphinx documentation to Pages
24

35
# Runs on pushes targeting the default branch

.github/workflows/pypi.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This file is generated from sphinx-notes/cookiecutter.
2+
13
name: Publish package distributions to PyPI
24

35
on:
@@ -14,8 +16,8 @@ jobs:
1416
permissions:
1517
id-token: write # IMPORTANT: this permission is mandatory for trusted publishing
1618
steps:
17-
- uses: actions/checkout@v4
18-
- uses: actions/setup-python@v5
19+
- uses: actions/checkout@v6
20+
- uses: actions/setup-python@v6
1921
- run: pip install build twine && make dist
2022
- uses: pypa/gh-action-pypi-publish@release/v1
2123
with:

.github/workflows/release.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This file is generated from sphinx-notes/cookiecutter.
2+
13
name: Publish Github Release
24

35
on:
@@ -11,7 +13,7 @@ jobs:
1113
permissions:
1214
contents: write
1315
steps:
14-
- uses: actions/checkout@v4
16+
- uses: actions/checkout@v6
1517
- uses: ncipollo/release-action@v1
1618
with:
1719
body: |

.github/workflows/test.yml

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# This file is generated from sphinx-notes/cookiecutter.
2+
13
name: Test
24
on:
35
push:
@@ -8,18 +10,19 @@ jobs:
810
test:
911
runs-on: ubuntu-latest
1012
steps:
11-
- uses: actions/checkout@v2
12-
- uses: actions/setup-python@v5
13+
- uses: actions/checkout@v6
14+
- uses: actions/setup-python@v6
1315
with:
1416
python-version-file: 'pyproject.toml'
1517
- run: python3 -m pip install .[test]
1618
- run: make test
1719
doctest:
1820
runs-on: ubuntu-latest
1921
steps:
20-
- uses: actions/checkout@v2
21-
- uses: actions/setup-python@v5
22+
- uses: actions/checkout@v6
23+
- uses: actions/setup-python@v6
2224
with:
2325
python-version-file: 'pyproject.toml'
24-
- run: python3 -m pip install .[docs]
26+
- run: python3 -m pip install .[test]
27+
- run: python3 -m pip install -r docs/requirements.txt
2528
- run: make doctest

docs/requirements.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@ sphinx-last-updated-by-git
1111
sphinxnotes-project
1212
sphinxnotes-comboroles
1313

14+
# NOTE: Not used by docs (docs import extension from ../src),
15+
# only to resolve its optional dependencies.
16+
sphinxnotes-render
17+
1418
# CUSTOM DOCS DEPENDENCIES START
1519
schema # python dict schema validation
1620
# CUSTOM DOCS DEPENDENCIES END

0 commit comments

Comments
 (0)