On 04/26/10 14:43, Andre Smit wrote:
Thanks Robert -
Reading through the guide I missed a writeup on contributing to the documentation side of the project. From what I've been able to gather from the source, the documents are in restructured text format and uses Sphinx, docutils, etc which is all new to me. I would like to at least review any changes I make before submitting changes or updates - but I'm guessing that this needs the documentation posted to a server that runs Sphinx? Any suggestions?
Ah, ok, this is easy, you can review the results on your computer:
install sphinx + numpydoc [0], set the path to numpydoc in site_cfg.py if needed.
edit the rst files in doc/ using any text editor (I use emacs) - the ReST format is really simple, so nothing fancy is needed. Follow the existing files in doc/, for reference check also [1-3].
(re)generate the documentation (assuming linux, for windows I could add a .bat file instead of Makefile, if needed)
cd doc make html
- view it
firefox _build/html/index.html # use your favorite browser
I found some editors: http://code.google.com/p/crunchy/ http://catherinedevlin.blogspot.com/2009/08/enthoughts-restructuredtext-edit...
Thanks for the links, but I guess your usual text editor (that you edit Python sources with) should do too.
cheers, r.
[0] http://pypi.python.org/pypi/numpydoc/0.3.1 [1] http://sphinx.pocoo.org/rest.html [2] http://sphinx.pocoo.org/markup/index.html [3] http://docutils.sourceforge.net/rst.html
-- You received this message because you are subscribed to the Google Groups "sfepy-devel" group. To post to this group, send email to sfepy...@googlegroups.com. To unsubscribe from this group, send email to sfepy-devel...@googlegroups.com. For more options, visit this group at http://groups.google.com/group/sfepy-devel?hl=en.