Skip to content

Commit c497ce1

Browse files
committed
docs: overhaul documentation structure and build
1 parent a14f3ed commit c497ce1

34 files changed

Lines changed: 2168 additions & 2314 deletions

.github/workflows/tests.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,10 +72,14 @@ jobs:
7272
cache: pip
7373
- name: install dependencies
7474
run: |
75-
pip install -e .
75+
pip install -e ".[html]"
7676
pip install sphinx -r docs/requirements.txt
7777
- name: build docs
7878
run: sphinx-build -W -b html docs docs/_build/html
79+
- name: run doctests
80+
run: sphinx-build -b doctest docs docs/_build/doctest
81+
- name: check links
82+
run: sphinx-build -b linkcheck docs docs/_build/linkcheck
7983

8084
typecheck:
8185
name: "typecheck"

docs/_themes/LICENSE.flask

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

docs/_themes/README.flask

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

docs/_themes/alabaster/about.html

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

docs/_themes/alabaster/alabaster_theme_support.py

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

docs/_themes/alabaster/donate.html

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

docs/_themes/alabaster/layout.html

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

docs/_themes/alabaster/navigation.html

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

0 commit comments

Comments
 (0)