More Documentation!

6 views
Skip to first unread message

Bruce Frederiksen

unread,
May 19, 2011, 12:08:30 PM5/19/11
to Naimath developers
OK, I've created a set of sphinx documentation for Project N.  Right now, this is just the autodoc feature to convert the __doc__ strings into HTML and create the links to make it easy to jump around reading it.  I've also turned on the sphinx feature which includes the source files themselves in the documentation (as "[source]" links).

So, if you're interested in the code, this is the place to go!

Then either unzip the attached file and point your browser to the html/index.html page, or:
  1. do an hg pull from SF to get this stuff (there are also some other bug fixes and stuff that you should get)
  2. pip install sphinx (probably in the virtualenv, otherwise I don't think it will be available when you activate the virtualenv).
  3. cd doc/sphinx
  4. make html (should work on all platforms)
  5. point your browser to doc/sphinx/build/html/index.html
Enjoy!

-Bruce
naimath.zip
Reply all
Reply to author
Forward
0 new messages