Skip to content

Commit 8014268

Browse files
committed
make docs helper
1 parent 7a78a3c commit 8014268

File tree

2 files changed

+14
-1
lines changed

2 files changed

+14
-1
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ venv/
4141
.env
4242

4343
docs/plans/
44+
docs/_build/
4445
.claude/*local*
4546
.claude/worktrees/
4647

Makefile

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,22 @@
11

2+
DOCS_PYTHON = .venv/bin/python
3+
DOCS_SOURCE = docs
4+
DOCS_BUILD = $(DOCS_SOURCE)/_build/html
5+
SPHINXOPTS ?=
6+
7+
.PHONY: clean docs test pypi codeql-db codeql-analyze codeql-clean
8+
29
clean:
310
find . -name '*.pyc' -exec rm -f {} \;
411
find . -name '*.py~' -exec rm -f {} \;
512
find . -name '__pycache__' -exec rm -rf {} \;
613
find . -name '.coverage.*' -exec rm -rf {} \;
7-
rm -rf build dist emails.egg-info tmp-emails _files
14+
rm -rf build dist emails.egg-info tmp-emails _files $(DOCS_SOURCE)/_build
15+
16+
docs:
17+
$(DOCS_PYTHON) -m sphinx -b html $(SPHINXOPTS) $(DOCS_SOURCE) $(DOCS_BUILD)
18+
@echo
19+
@echo "Build finished. Open $(DOCS_BUILD)/index.html"
820

921
test:
1022
tox

0 commit comments

Comments
 (0)