psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-22 17:06:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
9614e7241b
psycopg2/doc
History
Daniele Varrazzo 9614e7241b Further docs cleanup 
Recent Sphinx versions seem overly aggressive in autodetecting python,
or I just didn't notice the errors, so be explicit in what language to
use with code examples.
2017-11-06 18:34:23 +00:00
..
src Further docs cleanup 2017-11-06 18:34:23 +00:00
COPYING.LESSER Changes license to LGPL3 + OpenSSL exception on all source files 2010-02-12 23:34:53 +01:00
Makefile Disable uploading docs on pythonhosted 2017-08-23 13:42:49 +01:00
pep-0249.txt Fix multiple misspellings 2013-04-26 09:59:40 +01:00
README.rst Docs build process and docs cleaned up 2015-04-28 09:32:58 +01:00
release.rst Improved notes to release psycopg packages 2017-03-13 16:50:57 +00:00
requirements.txt Sphinx version do build docs updated to 1.6 2017-10-18 21:56:48 +01:00
SUCCESS Fix multiple misspellings 2013-04-26 09:59:40 +01:00

README.rst 

How to build psycopg documentation
----------------------------------

Building the documentation usually requires building the library too for
introspection, so you will need the same prerequisites_.  The only extra
prerequisite is virtualenv_: the packages needed to build the docs will be
installed when building the env.

.. _prerequisites: http://initd.org/psycopg/docs/install.html#install-from-source
.. _virtualenv: https://virtualenv.pypa.io/en/latest/

Build the env once with::

    make env

Then you can build the documentation with::

    make

Or the single targets::

    make html
    make text

You should find the rendered documentation in the ``html`` dir and the text
file ``psycopg2.txt``.