Sphinx documentation

Bernhard Morgenstern edited this page Apr 7, 2014 · 5 revisions

The API reference documentation of ObsPy is generated with Sphinx. In order to build it on your local machine, run

#!sh
cd /path/to/obspy/misc/docs
make pep8
make coverage
make html

Sphinx version 1.1 or higher has to be installed (e.g. via easy_install sphinx==1.1). In case of error messages involving matplotlib.sphinxext try updating the matplotlib installation.

A fully self-contained script to install a local Python environment suitable for building the docs from scratch is available here: https://github.com/obspy/sandbox/blob/master/buildbots/install_python.sh

More useful links on Sphinx:

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.