From c7408d9d1e33f2490c77a7a17ad72d4848d46d8b Mon Sep 17 00:00:00 2001 From: Oleg Pudeyev Date: Wed, 4 Jun 2014 13:43:09 -0400 Subject: Document building documentation --- README.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) (limited to 'README.rst') diff --git a/README.rst b/README.rst index c1d1eab..f32293c 100644 --- a/README.rst +++ b/README.rst @@ -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 `_. + +To build documentation from source, run ``make docs``. +Building documentation requires `Sphinx `_ 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 ------- -- cgit v1.2.1