I was looking around for a nice way to tie together the various
documentation snippets I've been writing up.  Sphinx looked
appealing, so I've set it up in my branch.  numpydoc provides
the docstring parsing, so take a look at
  http://projects.scipy.org/numpy/wiki/CodingStyleGuidelines
for any docstrings you add in the future.

Pull my branch, run `make sphinx`, and point your browser at
doc/.build/html/index.html.  You may need to install Sphinx
  easy_install sphinx
and numpydoc
  easy_install numpydoc

We may want to put the generated html tree into released tarballs (via
release.py), but I haven't done anything on that front yet.

-- 
This email may be signed or encrypted with GPG (http://www.gnupg.org).
The GPG signature (if present) will be attached as 'signature.asc'.
For more information, see http://en.wikipedia.org/wiki/Pretty_Good_Privacy

My public key is at http://www.physics.drexel.edu/~wking/pubkey.txt

Attachment: pgpYbXAW3ACrp.pgp
Description: PGP signature

_______________________________________________
Be-devel mailing list
[email protected]
http://void.printf.net/cgi-bin/mailman/listinfo/be-devel

Reply via email to