more docstring for API doc - Githubissues

ecell / ecell4_base

An integrated software environment for multi-algorithm, multi-timescale, multi-spatial-representation simulation of various cellular phenomena

https://ecell4.e-cell.org/

GNU General Public License v3.0

63 stars 23 forks source link

more docstring for API doc #27

Closed kozo2 closed 9 years ago

kozo2 commented 9 years ago

[x] ecell4.core
[x] ecell4.ode
[x] ecell4.gillespie
[x] ecell4.meso
[x] ecell4.lattice
[x] ecell4.bd
[x] ecell4.egfrd
[x] ecell4.util
[x] ecell4.util.decorator
[x] ecell4.util.viz

kaizu commented 9 years ago

Almost done.

kaizu commented 9 years ago

I should follow the way of comments in numpy and matplotlib. I will reformat all.

kaizu commented 9 years ago

Ok, I reformatted almost all docstrings.

kaizu commented 9 years ago

Please refer the following to add a docstring:

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

kozo2 commented 9 years ago

We need to fix

ERROR: Unknown directive type "autosummary".

kaizu commented 9 years ago

Add lines to conf.py as follows:

extensions = [
    'sphinx.ext.autodoc',
    'numpydoc',
    'sphinx.ext.autosummary'
]

numpydoc_show_class_members = False

It looks working nicely for me. See http://stackoverflow.com/questions/20334804/sphinx-autodoc-and-numpydoc also.

kaizu commented 9 years ago

Done. Move to Pull Request for docstring branch.