pysal

Previous topic

PEP 0003 Spatial Smoothing Module

Next topic

PySAL Release Managment

This Page

Building PySAL DocumentationΒΆ

PySAL documentation is built using Sphinx. We also use the numpydoc extension to Sphinx which customizes the markup of the docstrings of the PySAL modules.

The source for the docs is in trunk/doc. Building the documentation is done as follows (assuming sphinx and numpydoc are already installed):

serge@think:~/Research/p/PySAL/src/google/trunk/doc$ ls
build  Makefile  source

serge@think:~/Research/p/PySAL/src/google/trunk/doc$ make clean;make html

To see the results in a browser open build/html/index.html. To make changes, edit (or add) the relevant files in source and rebuild the docs. Consult the Sphinx markup guide for details on the syntax and structure of the files in source.

Once you are happy with your changes, check-in the source files, do not add or check-in files under build since they are dynamically built.

Changes added to the svn repository will be propogated to pysal.org on an hourly basis (at 32 minutes after the hour to be exact).