diff options
| author | Olivier Tilloy <olivier@tilloy.net> | 2010-02-16 17:01:12 +0100 |
|---|---|---|
| committer | Olivier Tilloy <olivier@tilloy.net> | 2010-02-16 17:01:12 +0100 |
| commit | 871d24f9d959fe5cf9664bbb4f00ea94ff9b58f0 (patch) | |
| tree | 6f135dd0511fbc7d80988b1a77839054e25d9441 /doc | |
| parent | f27613c802b1a0b5bff0f6eb3849ab4c8aac59bc (diff) | |
| download | pyexiv2-871d24f9d959fe5cf9664bbb4f00ea94ff9b58f0.tar.gz | |
Developers documentation: `scons doc` (re)builds the HTML documentation.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developers.rst | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/developers.rst b/doc/developers.rst index d0b8326..8bf39bd 100644 --- a/doc/developers.rst +++ b/doc/developers.rst @@ -76,12 +76,14 @@ Documentation The present documentation is generated using `Sphinx <http://sphinx.pocoo.org/>`_ from reStructuredText sources found in the -doc/ directory. Issue the following command to (re)build the HTML -documentation:: +doc/ directory. Invoke ``scons doc`` to (re)build the HTML documentation. +Alternatively, you can issue the following command:: sphinx-build -b html doc/ doc/_build/ The index of the documentation will then be found under doc/_build/index.html. +Note that you will need pyexiv2 to be installed system-wide or to be found on +the ``PYTHONPATH`` for the documentation to build successfully. Unit tests ########## |