Re: Docs docs docs!

[Ben Bangert]

I've gotten the basic Sphinx setup working now, and have gotten the Getting Started doc done. Here's what the Sphinx doc build looks like so far:

http://docs.pylonshq.com/





To run it, just use the following command:

I've got most of the module API docs laid out too. I should note that this doc effort covers a few related packages as well, to update them with Sphinx restructured text syntax (the previous pudge doc string syntax breaks in a few places under Sphinx). If you'd like to get started, here's the steps. First, I've put together a single script that will create a virtualenv, install Mercurial into it, grab all the source repo's for core Pylons packages (pylons, beaker, weberror, webhelpers, routes), and do svn checkouts of the other core packages (Paste, PasteScript, PasteDeploy, WebOb). curl http://pylonshq.com/download/0.9.7/go-pylons-dev.py | python - -- no-site-packages superdevenv

http://docs.pylonshq.com/modindex.html







Cheers,
Ben

That will setup the whole thing underneath the directory 'superdevenv', this command does require svn to already be installed, but doesn't require Mercurial to be installed as that's setup for you in the directory you choose ('superdevenv' in this example). To run the Sphinx build locally, first install Sphinx: ./superdevenv/ bin/easy_install -U Sphinx. Then go to superdevenv/pylons/pylons/docs and type: make html That should build the HTML source in a _build dir where you can then browse it. All the packages will also be setup in develop mode, so you can then work on docs in various packages so we'll have powerful module API docs for here: Which is helpful because we'll want to cross-link to them frequently to avoid repetition in the actual docs. So far, I've gotten some of the TOC filled in, and have setup placeholders in sections with what I believe should be covered by that section. I still need to add an Internationalization section as well. If you'd like to help out, and/or have already stated that, just setup a dev env like I mention here, find a section of the docs you'd like to work on, and announce it here so we avoid working on the same doc. :) Or we could just setup a page on the wiki to track who's working on which sections.

smime.p7s
Description: S/MIME cryptographic signature