Pylons Docs site

4 views

Skip to first unread message

Anand Vaidya

unread,

Feb 9, 2010, 8:40:12 AM2/9/10

to pylons-discuss

Hi All,

I am very impressed with the Pylons docs site (http://pylonshq.com/
docs/en/1.0/) . I am looking for a similar documentation site for
another python project.

So here are my questions:

1. Is the docs built with RST or Textile? comments accept textile
input.

2. I guess the docs site is pylons powered. So what is the CMS or app
serving the docs? Is this app available for downloading and use Or
can I get the source for the app and install on my server?

3. How is the content maintained? Does someone (core-dev?) write RST/
markdown/textile formatted text files and run sphinx? Or does the
magical pylons app allow WYSIWYG editing?

Thanks In Advance!

Ben Bangert

unread,

Feb 9, 2010, 1:10:39 PM2/9/10

to pylons-...@googlegroups.com

On Feb 9, 2010, at 5:40 AM, Anand Vaidya wrote:

> I am very impressed with the Pylons docs site (http://pylonshq.com/
> docs/en/1.0/) . I am looking for a similar documentation site for
> another python project.
>
> So here are my questions:
>
> 1. Is the docs built with RST or Textile? comments accept textile
> input.

The docs are built with the Sphinx tool:
http://sphinx.pocoo.org/

To ease updates, I have an uploader that uploads them to the PylonsHQ site, where they're stored in CouchDB in the same JSON-type format that they're saved into when Sphinx builds the docs for 'web'. The code for the uploader is here:
http://bitbucket.org/bbangert/pylons/src/tip/pylons/docs/uploader.py

The PylonsHQ site is running Pylons with CouchDB. The comments are stored in CouchDB, and the doc viewing/uploading is handled by the docs controller in the PylonsHQ project (called Kai):
http://bitbucket.org/bbangert/kai/src/tip/kai/controllers/docs.py

> 2. I guess the docs site is pylons powered. So what is the CMS or app
> serving the docs? Is this app available for downloading and use Or
> can I get the source for the app and install on my server?

Yep, it's available as Kai from above. Note that I put the project up for those curious, there's no actual support for it. You should be quite familiar with Pylons before attempting to try it out.

> 3. How is the content maintained? Does someone (core-dev?) write RST/
> markdown/textile formatted text files and run sphinx? Or does the
> magical pylons app allow WYSIWYG editing?

They're all RST docs, as that's what Sphinx uses.

Note that you can also use Sphinx and upload docs to http://packages.python.org/ where it will look like whatever Sphinx theme you've chosen.