Hi Robert,
I finally got some time to update the documentation. The results are at [1] and you can pull the github repo at [2]. I finished most of the sfepy directory, except for fem and terms. Using the sphinx automodule directive with the members and undoc-members sped things up considerably. Let me know if you like the resulting style, or if it should be changed.
Currently, there's an rst file for each module in the sfepy hierarchy. I'm wondering if I should roll it all into one big file, or do you think it's fine the way it is?
Also, I encountered some issues with the formatting of the docstring. Most were warnings (probably due to the docstrings not yet being in sphinx compatible format), but I got several of the following types of errors:
logan@quantumdot:~/projects/sfepy/doc$ make html PYTHONPATH=.. sphinx-build -b html -d _build/doctrees . _build/html Running Sphinx v0.6.3 loading pickled environment... done building [html]: targets for 1 source files that are out of date updating environment: 15 added, 1 changed, 0 removed reading sources... [ 18%] module_sfepy_geom_geometry reST markup error: /home/logan/projects/sfepy/sfepy/geom/geometry.py:docstring of sfepy.geom.geometry.geometry:13: (SEVERE/4) Unexpected section title.
Example:
make: *** [html] Error 1
It looks like we aren't allowed to have sections in the docstrings for the sphinx autodoc. So I removed the underscore line and appended a colon in the source code when I encountered these problems. Do you think this is good, or should I look for a better solution?
Finally, I put some placeholders in for the other manuals in the documentation. I'm thinking something like the following:
introduction tutorial users_guide examples developer_guide <--- currently has sfepy module documentation documentation_guide
Any suggestions/thoughts here?
Thanks! Logan
[1] http://logansorenson.github.com/sfepy_doc2/ [2] git://github.com/logansorenson/sfepy_doc2.git