diff options
| author | Ben McGinnes <[email protected]> | 2018-12-04 22:17:31 +0000 |
|---|---|---|
| committer | Ben McGinnes <[email protected]> | 2018-12-04 22:17:31 +0000 |
| commit | 6d8823b81162c18406d40ec59bd252cfdf1df648 (patch) | |
| tree | 9a05b7a38e66dac7301c764b9df240178a35e862 /lang/python/doc/rst/index.rst | |
| parent | Merge branch 'master' of ssh+git://playfair.gnupg.org/git/gpgme (diff) | |
| download | gpgme-6d8823b81162c18406d40ec59bd252cfdf1df648.tar.gz gpgme-6d8823b81162c18406d40ec59bd252cfdf1df648.zip | |
python: Sphinx support
* Added framework from sphinx-quickstart to lang/python/doc/rst/ so
that Python developers already using Sphinx can use the generated
reST files with existing documentation systems.
* Note that when generating source files from Org-mode, the index page
will require manual intervention to match the Sphinx requirements.
Signed-off-by: Ben McGinnes <[email protected]>
Diffstat (limited to 'lang/python/doc/rst/index.rst')
| -rw-r--r-- | lang/python/doc/rst/index.rst | 17 |
1 files changed, 16 insertions, 1 deletions
diff --git a/lang/python/doc/rst/index.rst b/lang/python/doc/rst/index.rst index 746391c3..9c4f0f7a 100644 --- a/lang/python/doc/rst/index.rst +++ b/lang/python/doc/rst/index.rst @@ -1,8 +1,15 @@ -.. _top: +.. GPGME Python Bindings documentation master file, created by + sphinx-quickstart on Wed Dec 5 09:04:47 2018. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. GPGME Python Bindings ===================== +.. toctree:: + :maxdepth: 2 + :caption: Contents: + Contents -------- @@ -13,3 +20,11 @@ Contents - `What Was New <what-was-new>`__ - `GPGME Python Bindings HOWTO <gpgme-python-howto>`__ + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` |