couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Dave Cottlehuber <...@jsonified.com>
Subject Re: couch has docs!
Date Thu, 27 Sep 2012 06:39:29 GMT
On 27 September 2012 07:07, john.tiger <john.tigernassau@gmail.com> wrote:
> maybe it's late, but I cannot figure out the docs build from linux
> "make html" did not work,  neither did python conf.py - what am i missing ?

Hi John,

Thanks for giving it a go. I've not tested the python stuff on linux
so it might be some platform specific issue I'm missing.

0. You'll need to `git checkout -b origin/docs` to switch to the only
branch that has the doc stuff in it
1. http://wiki.apache.org/couchdb/Documentation#Setting_up_Python_and_Sphinx_for_the_first_time
2. run this which should work:

sphinx-build -a -E -W -n \
-D version='$ver' \
-D release='$ver-git-sha' \
-D project='Apache CouchDB' \
-D copyright='$year, Apache Software Foundation' \
-d $TMPDIR/couchdocs/ \
rst/ \
`pwd`/manual

Feel free to give the github approach a go
http://wiki.apache.org/couchdb/Documentation#Editing_Documentation_via_GitHub
as well.

The wiki is ripe for updating if you get it to work; I'm away for the
next few days.

A+
Dave

Mime
View raw message