Move documentation to ReadTheDocs, refs #7

This commit is contained in:
Simon Willison 2023-07-17 16:39:39 -07:00
commit 7ee22a8a5e
10 changed files with 576 additions and 187 deletions

37
Justfile Normal file
View file

@ -0,0 +1,37 @@
# Run tests and linters
@default: test lint
# Install dependencies and test dependencies
@init:
pipenv run pip install -e '.[test]'
# Run pytest with supplied options
@test *options:
pipenv run pytest {{options}}
# Run linters
@lint:
echo "Linters..."
echo " Black"
pipenv run black . --check
echo " cog"
pipenv run cog --check README.md docs/*.md
echo " ruff"
pipenv run ruff .
# Rebuild docs with cog
@cog:
pipenv run cog -r docs/*.md
# Serve live docs on localhost:8000
@docs: cog
cd docs && pipenv run make livehtml
# Apply Black
@black:
pipenv run black .
# Run automatic fixes
@fix: cog
pipenv run ruff . --fix
pipenv run black .