diff options
| author | Robert Kern <robert.kern@gmail.com> | 2008-01-22 06:31:01 +0000 |
|---|---|---|
| committer | Robert Kern <robert.kern@gmail.com> | 2008-01-22 06:31:01 +0000 |
| commit | d1c740cf51aacd08c10f18582b66a4856f131f55 (patch) | |
| tree | 6b6115064144d3fcde0531bf5f6c4b2fe1aada1a /numpy/doc/HOWTO_DOCUMENT.txt | |
| parent | 7e4b1515b93fb557298bf65566504e5b6f6b9268 (diff) | |
| download | numpy-d1c740cf51aacd08c10f18582b66a4856f131f55.tar.gz | |
Set __docformat__ such that epydoc knows it's looking at reST instead of epytext.
Diffstat (limited to 'numpy/doc/HOWTO_DOCUMENT.txt')
| -rw-r--r-- | numpy/doc/HOWTO_DOCUMENT.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/numpy/doc/HOWTO_DOCUMENT.txt b/numpy/doc/HOWTO_DOCUMENT.txt index 923538f72..de5d0ce37 100644 --- a/numpy/doc/HOWTO_DOCUMENT.txt +++ b/numpy/doc/HOWTO_DOCUMENT.txt @@ -160,6 +160,11 @@ Currently, we recommend that you build epydoc from the trunk:: cd epydoc/src sudo python setup.py install +Since we use reST-formatted docstrings instead of the epytext markup, you will +need to include the following line near the top of your module:: + + __docformat__ = "restructuredtext en" + The appearance of some elements can be changed in the epydoc.css style sheet. |