diff --git a/Makefile b/Makefile index 94757f4..c2d0f50 100644 --- a/Makefile +++ b/Makefile @@ -11,12 +11,11 @@ venv: ## Create the venv python3 -m venv venv develop: venv ## Install the dev dependencies venv/bin/pip install -e ".[dev,docs]" -docs: cog public/mermaid.min.js ## Build the docs +docs: cog ## Build the docs venv/bin/sphinx-build docs public + if [[ ! -e public/mermaid.min.js ]]; then curl -sL $$(grep mermaid.min.js public/search.html | cut -f 2 -d '"') --output public/mermaid.min.js; fi sed -e 's@https://unpkg.com/mermaid[^"]*"@mermaid.min.js"@' -i public/search.html public/genindex.html sed -e 's@https://unpkg.com/mermaid[^"]*"@../mermaid.min.js"@' -i public/developer/models.html public/developer/overview.html -public/mermaid.min.js: - curl -sL $$(grep mermaid.min.js public/search.html | cut -f 2 -d '"') --output public/mermaid.min.js cog: ## Run cog, to integrate the CLI options to the docs. venv/bin/cog -r docs/*.md test: venv ## Run the tests diff --git a/docs/index.md b/docs/index.md index d76f475..6d09e90 100644 --- a/docs/index.md +++ b/docs/index.md @@ -64,5 +64,6 @@ developer/new-check developer/models developer/migrations developer/tests +developer/release ```