Skip to content

Commit

Permalink
[infra] move the docs build machinery into ./docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stonier committed Apr 28, 2019
1 parent f2ee818 commit 191319f
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 9 deletions.
7 changes: 0 additions & 7 deletions Makefile

This file was deleted.

16 changes: 16 additions & 0 deletions doc/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
all:
@echo "This makefile is for building documentation"
@echo "in the virtual environment via '. ./venv.bash'"
@echo ""
@echo "Valid targets:"
@echo ""
@echo " docs: build the sphinx documentation in ./html"
@echo " clean: clean out the html directory"

docs:
sphinx-build -v -b html . html

clean:
rm -rf html

.PHONY: docs clean
4 changes: 2 additions & 2 deletions docenv.bash → doc/venv.bash
Original file line number Diff line number Diff line change
Expand Up @@ -89,10 +89,10 @@ fi

# Get all dependencies for doc generation
# pip install -e .[docs]
pip install -r doc/requirements.txt
pip install -r requirements.txt

# NB: this automagically nabs install_requires
python setup.py develop
python ../setup.py develop

echo ""
echo "Leave the virtual environment with 'deactivate'"
Expand Down

0 comments on commit 191319f

Please sign in to comment.