debian/notmuch
1
0
Fork 0
mirror of https://git.notmuchmail.org/git/notmuch synced 2025-01-03 15:21:41 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

python: strip module prefix in the sphinx documentation

Browse source 
Remove the notmuch prefix from classes in the documentation. This
change makes the table of contents look much nicer.

Signed-off-by: Justus Winter <4winter@informatik.uni-hamburg.de>
This commit is contained in:
Justus Winter 2012-02-24 00:38:47 +01:00
parent 90fb4e8334
commit fb52083bf7
1 changed files with 17 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
bindings/python/docs/source/index.rst
View file

@ -42,10 +42,10 @@ More information on specific topics can be found on the following pages:
.. automodule:: notmuch
:class:`notmuch.Database` -- The underlying notmuch database
:class:`Database` -- The underlying notmuch database
---------------------------------------------------------------------
.. autoclass:: notmuch.Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
.. autoclass:: Database([path=None[, create=False[, mode=MODE.READ_ONLY]]])
.. automethod:: create
@ -90,10 +90,10 @@ More information on specific topics can be found on the following pages:
.. autoattribute:: db_p
:class:`notmuch.Query` -- A search query
:class:`Query` -- A search query
-------------------------------------------------
.. autoclass:: notmuch.Query
.. autoclass:: Query
.. automethod:: create
@ -216,10 +216,10 @@ More information on specific topics can be found on the following pages:
.. automethod:: __str__
:class:`notmuch.Threads` -- Threads iterator
:class:`Threads` -- Threads iterator
-----------------------------------------------------
.. autoclass:: notmuch.Threads
.. autoclass:: Threads
.. automethod:: __len__
@ -254,28 +254,28 @@ More information on specific topics can be found on the following pages:
:class:`Filenames` -- An iterator over filenames
------------------------------------------------
.. autoclass:: notmuch.Filenames
.. autoclass:: Filenames
.. automethod:: notmuch.Filenames.__len__
.. automethod:: Filenames.__len__
.. automethod:: notmuch.Filenames.as_generator
.. automethod:: Filenames.as_generator
:class:`notmuch.database.Directoy` -- A directory entry in the database
:class:`Directoy` -- A directory entry in the database
------------------------------------------------------------------------
.. autoclass:: notmuch.Directory
.. autoclass:: Directory
.. automethod:: notmuch.Directory.get_child_files
.. automethod:: Directory.get_child_files
.. automethod:: notmuch.Directory.get_child_directories
.. automethod:: Directory.get_child_directories
.. automethod:: notmuch.Directory.get_mtime
.. automethod:: Directory.get_mtime
.. automethod:: notmuch.Directory.set_mtime
.. automethod:: Directory.set_mtime
.. autoattribute:: notmuch.Directory.mtime
.. autoattribute:: Directory.mtime
.. autoattribute:: notmuch.Directory.path
.. autoattribute:: Directory.path
The `next page <status_and_errors.html>`_ contains information on possible Status and Error values.