diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2014-06-04 13:43:09 -0400 |
|---|---|---|
| committer | Oleg Pudeyev <oleg@bsdpower.com> | 2014-06-04 13:43:09 -0400 |
| commit | c7408d9d1e33f2490c77a7a17ad72d4848d46d8b (patch) | |
| tree | e9c23eca3080e93e5dc7dca9ea47168b8b2571ee /README.rst | |
| parent | adcbf9189d60affdafb23b5e94f950727d9b01fc (diff) | |
| download | pycurl-c7408d9d1e33f2490c77a7a17ad72d4848d46d8b.tar.gz | |
Document building documentation
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 12 |
1 files changed, 12 insertions, 0 deletions
@@ -48,6 +48,18 @@ Installation Please see INSTALL.rst for installation instructions. +Documentation +------------- + +Documentation for the most recent PycURL release is available on +`PycURL website <http://pycurl.sourceforge.net/doc/>`_. + +To build documentation from source, run ``make docs``. +Building documentation requires `Sphinx <http://sphinx-doc.org/>`_ to +be installed, as well as pycurl extension module built as docstrings are +extracted from it. Built documentation is stored in ``build/doc`` +subdirectory. + Support ------- |