Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ jobs:
- uses: astral-sh/setup-uv@v6
with:
enable-cache: true
- run: uv python install 3.11
- run: uv python install 3.12

- run: make install-docs
- run: make doc

- name: Deploy
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/build
keep_files: true
# - name: Deploy
# uses: peaceiris/actions-gh-pages@v4
# with:
# github_token: ${{ secrets.GITHUB_TOKEN }}
# publish_dir: ./docs/build
# keep_files: true
19 changes: 18 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,25 @@ check:
coverage:
uv run pytest --cov=my_pkg --cov-report=xml # todo: change my_pkg to the actual package name

cov:
uv run pytest --cov=my_pkg --cov-report=term-missing # todo: change my_pkg to the actual package name

mypy:
uv tool run mypy my_pkg --config-file pyproject.toml # todo: chanege my_pkg to the actual package name
uv tool run mypy my_pkg --config-file pyproject.toml
# todo: chanege my_pkg to the actual package name

doc:
uv run sphinx-build -M html docs/source docs/build/


doctest:
uv run sphinx-build -M doctest docs/source docs/build/ -W --keep-going

# Optional target that builds docs but ignores warnings
doc-build:
uv run sphinx-build -M html docs/source docs/build/


doc: doctest doc-build

check-all: check test mypy doc
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@

html_theme = "sphinx_rtd_theme"
master_doc = "index"
html_static_path = ["_static"]
# html_static_path = ["_static"]
8 changes: 6 additions & 2 deletions renovate.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,10 +42,14 @@
},
{
"matchManagers": [
"pep621", "pep723"
"pip-compile",
"pip_requirements",
"pip_setup",
"pipenv",
"poetry"
],
"labels": [
"uv-lock",
"python",
"renovate"
]
}
Expand Down
Empty file removed tests/docs/__init__.py
Empty file.
41 changes: 0 additions & 41 deletions tests/docs/test_docs.py

This file was deleted.