wassname/catalyst
1
0
Fork 0
mirror of https://github.com/wassname/catalyst.git synced 2026-08-09 11:50:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

DOC/DEV: Add sphinx-autobuild to docs.

Browse Source 
Adds a `make livehtml` target that spawns a server that rebuilds and
serves the docs every time a change happens.
This commit is contained in:
Scott Sanderson
2016-05-27 16:39:29 -04:00
parent 3ffe9a0536
commit 05ac438c3c
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/Makefile
+5 -1
View File
@@ -19,12 +19,13 @@ ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) sou
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help build clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
.PHONY: help build clean html livehtml dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " build to build the C and Cython extensions for zipline"
@echo " html to make standalone HTML files"
@echo " livehtml to run a persistent process that rebuilds the docs"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@@ -61,6 +62,9 @@ html: build
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
livehtml: build
sphinx-autobuild -p 9999 -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
dirhtml: build
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
etc/requirements_docs.txt
+1
View File
@@ -1,2 +1,3 @@
Sphinx>=1.3.2
numpydoc>=0.5.0
sphinx-autobuild==0.6.0