couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Couchdb Wiki] Update of "Documentation" by DaveCottlehuber
Date Wed, 03 Oct 2012 12:13:30 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.

The "Documentation" page has been changed by DaveCottlehuber:
http://wiki.apache.org/couchdb/Documentation?action=diff&rev1=25&rev2=26

Comment:
switch between single page and separate page HTML output

   * read the following tutorials and style guide
   * clone the [[https://git-wip-us.apache.org/repos/asf/couchdb.git|couchdb repository]]
   * set up the python toolchain as below
-  * edit .rst files as needed in {{{share/docs}}}
+  * edit .rst files as needed in {{{share/doc}}}
-  * build using this command in {{{share/docs}}}, replacing version, release, year as required
+  * build using this command in {{{share/doc}}}, replacing version, release, year as required,
to generate separate HTML pages per chapter:
  
  {{{
- sphinx-build -a -E -W -n \
+ sphinx-build -a -E -W -n -b html \
  -D version='$ver' \
  -D release='$ver-git-sha' \
  -D project='Apache CouchDB' \
@@ -34, +34 @@

  src/ \
  `pwd`/manual
  }}}
+ 
+  * this variant produces a single HTML page for the whole docs:
+ 
+ {{{
+ sphinx-build -a -E -W -n -b singlehtml \
+ -D version='$ver' \
+ -D release='$ver-git-sha' \
+ -D project='Apache CouchDB' \
+ -D copyright='$year, Apache Software Foundation' \
+ -d $TMPDIR/couchdocs/ \
+ src/ \
+ `pwd`/manual
+ }}}
+ 
   * check changes, make a patch & attach to a JIRA ticket, or send a pull request via
github
  
  = RestructuredText and Sphinx Tutorials =

Mime
View raw message