Skip to content

Commit

Permalink
Add requirements file for ReadTheDocs
Browse files Browse the repository at this point in the history
  • Loading branch information
jacebrowning committed Jan 24, 2019
1 parent 1a5ea8c commit 9313705
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -92,13 +92,16 @@ docs: mkdocs uml ## Generate documentation and UML

.PHONY: mkdocs
mkdocs: install $(MKDOCS_INDEX)
$(MKDOCS_INDEX): mkdocs.yml docs/*.md
$(MKDOCS_INDEX): docs/requirements.txt mkdocs.yml docs/*.md
@ mkdir -p docs/about
@ cd docs/about && ln -sf ../../CHANGELOG.md changelog.md
@ cd docs/about && ln -sf ../../CONTRIBUTING.md contributing.md
@ cd docs/about && ln -sf ../../LICENSE.md license.md
poetry run mkdocs build --clean --strict

docs/requirements.txt: poetry.lock
poetry run pip freeze | grep mkdocs > $@

.PHONY: mkdocs-live
mkdocs-live: mkdocs
eval "sleep 3; bin/open http://127.0.0.1:8000" &
Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
mkdocs==1.0.4

0 comments on commit 9313705

Please sign in to comment.