diff options
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. |