addmessageheader: Add a note about the incorrect rendering of the docstring

The note tells people to look at the source of the method, which
spinx.ext.viewcode conveniently links right next to the methods
signature.

Signed-off-by: Wieland Hoffmann <themineo@gmail.com>
This commit is contained in:
Wieland Hoffmann
2015-01-11 18:15:16 +01:00
committed by Nicolas Sebrecht
parent 29e9b7ab39
commit d08f6d15c2
2 changed files with 7 additions and 1 deletions

View File

@ -23,7 +23,8 @@ from offlineimap import __version__,__author__
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.intersphinx', 'sphinx.ext.todo']
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest',
'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.viewcode']
autoclass_content = "both"
# Add any paths that contain templates here, relative to this directory.