Add `make server` command to preview docs

This commit is contained in:
Daniel Gasienica 2013-06-01 21:25:51 -07:00
parent 766a2db0d9
commit b4df0b17af
2 changed files with 5 additions and 1 deletions

View File

@ -6,6 +6,7 @@ SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
PYTHON = python
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
@ -38,6 +39,7 @@ help:
# @echo " linkcheck to check all external links for integrity"
# @echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " docs to build the docs and copy the static files to the outputdir"
@echo " server to serve the docs in your browser under \`http://localhost:8000\`"
@echo " publish to publish the app to dotcloud"
clean:
@ -49,6 +51,8 @@ docs:
@echo
@echo "Build finished. The documentation pages are now in $(BUILDDIR)/html."
server:
@cd $(BUILDDIR)/html; $(PYTHON) -m SimpleHTTPServer 8000
site:
cp -r website $(BUILDDIR)/

View File

@ -23,7 +23,7 @@ Usage
* change the .rst files with your favorite editor to your liking
* run *make docs* to clean up old files and generate new ones
* your static website can now be found in the _build dir
* to preview what you have generated, cd into _build/html and then run 'python -m SimpleHTTPServer 8000'
* to preview what you have generated run `make server` and open <http://localhost:8000/> in your favorite browser.
Working using github's file editor
----------------------------------