Skip to content

Commit ec8a4e2

Browse files
grstflying-sheep
andauthored
Delete docs/Makefile (#383)
* Delete docs/Makefile How to build docs is defined via hatch in `pyproject.toml` This Makefile is the default from sphinx, but I don't think we should keep it anymore as the pyproject.toml is the single point of truth * fix workflow * oops * fix instructions * oops --------- Co-authored-by: Phil Schaf <flying-sheep@web.de>
1 parent 28d6261 commit ec8a4e2

3 files changed

Lines changed: 6 additions & 28 deletions

File tree

.github/workflows/test.yaml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242
if: matrix.os == 'ubuntu-latest'
4343
run: sudo apt-get install pandoc
4444
- name: Install build & check dependencies
45-
run: python -m pip install --upgrade pip wheel cookiecutter pre-commit
45+
run: python -m pip install --upgrade pip wheel cookiecutter pre-commit hatch
4646
# Build
4747
- name: Build from template
4848
shell: python
@@ -52,7 +52,7 @@ jobs:
5252
cookiecutter('.', no_input=True, extra_context=overrides)
5353
# Check
5454
- name: Set up pre-commit cache
55-
uses: actions/cache@v3
55+
uses: actions/cache@v4
5656
with:
5757
path: ~/.cache/pre-commit
5858
key: pre-commit-3|${{ matrix.python }}|${{ hashFiles(format('{0}/.pre-commit-config.yaml', env.PROJECT_ROOT)) }}
@@ -64,15 +64,13 @@ jobs:
6464
- name: Install the package
6565
run: |
6666
cd $PROJECT_ROOT
67-
pip install ".[doc]"
67+
pip install .
6868
python -c "import ${{ matrix.package-name }}"
6969
# Docs
7070
- name: Build the documentation
71-
env:
72-
SPHINXOPTS: -W --keep-going
7371
run: |
74-
cd "$PROJECT_ROOT/docs"
75-
make html
72+
cd $PROJECT_ROOT
73+
hatch run docs:build -W
7674
7775
test-scripts:
7876
runs-on: ubuntu-latest

{{cookiecutter.project_name}}/docs/Makefile

Lines changed: 0 additions & 20 deletions
This file was deleted.

{{cookiecutter.project_name}}/docs/contributing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ hatch run docs:open
209209
```bash
210210
source .venv/bin/activate
211211
cd docs
212-
make html
212+
sphinx-build -M html . _build -W
213213
(xdg-)open _build/html/index.html
214214
```
215215

0 commit comments

Comments
 (0)