Skip to content
This repository has been archived by the owner on Apr 30, 2024. It is now read-only.

Small doc-related improvements #149

Merged
merged 2 commits into from
Oct 6, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 25 additions & 17 deletions doc/how_to_build_docs.txt
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
You must have a .pth file in your path which includes
the path of your google_appengine sdk
1. You must have a .pth file in your site-packages directory with
the path of your google_appengine sdk. For Unix environments just create a file here:

pip install -r doc/requirements.txt
$VIRTUAL_ENV/lib/python2.7/site-packages/appengine.pth

http://sphinx-doc.org/invocation.html#invocation-apidoc
Auto build doc source from project source
with cwd the doc directory:
sphinx-apidoc -T -s txt -o source ../furious
sphinx-apidoc -T -s txt -o source ../example
with the path:

to force rebuild the rsts, include -f.
sphinx-apidoc -T -f -s txt -o source ../furious
sphinx-apidoc -T -f -s txt -o source ../example
/usr/local/google_appengine


http://sphinx-doc.org/invocation.html
Build docs from source:
make html
2. Install the requirements:

Sometimes the docs don't update and
you need to remove doc/build/doctrees
rm -Rf build/doctrees
$ pip install -r doc/requirements.txt


3. Auto build doc source from project source (run from the doc directory):
(http://sphinx-doc.org/invocation.html#invocation-apidoc)
$ sphinx-apidoc -T -s txt -o source ../furious
$ sphinx-apidoc -T -s txt -o source ../example

to force rebuild the rsts, include -f:
(http://sphinx-doc.org/invocation.html)
$ sphinx-apidoc -T -f -s txt -o source ../furious
$ sphinx-apidoc -T -f -s txt -o source ../example


4. Build docs from source:
$ make html

Sometimes the docs don't update and you need to remove doc/build/doctrees:
$ rm -Rf build/doctrees


2 changes: 1 addition & 1 deletion doc/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Jinja2==2.6
Pygments==1.6
Sphinx==1.1.3
docutils==0.10
docutils==0.12
python-termstyle==0.1.10
wsgiref==0.1.2