This repository has been archived by the owner on Aug 9, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
10 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,23 +1,25 @@ | ||
# All targets are run under poetry, so the activation of the virtual environment | ||
# is not necessary. | ||
.PHONY: docs | ||
docs: ## Build project documentation with live reload for editing. | ||
@echo "███ Building docs and watching for changes..." | ||
make clean && sphinx-autobuild docs docs/_build/html | ||
@poetry run make clean && poetry run sphinx-autobuild docs docs/_build/html | ||
@echo | ||
|
||
.PHONY: docs-lint | ||
docs-lint: ## Check documentation for common syntax errors. | ||
@echo "███ Linting documentation..." | ||
# The `-W` option converts warnings to errors. | ||
# The `-n` option enables "nit-picky" mode. | ||
@make clean && sphinx-build -Wn docs docs/_build/html | ||
@make clean && poetry run sphinx-build -Wn docs docs/_build/html | ||
@echo | ||
|
||
.PHONY: docs-linkcheck | ||
docs-linkcheck: ## Check documentation for broken links. | ||
@make clean && sphinx-build -b linkcheck -Wn docs docs/_build/html | ||
@make clean && poetry run sphinx-build -b linkcheck -Wn docs docs/_build/html | ||
@echo | ||
|
||
# Catch-all target: route all unknown targets to Sphinx using the new | ||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | ||
%: | ||
@sphinx-build -M $@ docs docs/_build | ||
@poetry run sphinx-build -M $@ docs docs/_build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters