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] Trivial Update of "Documentation" by DaveCottlehuber
Date Wed, 26 Sep 2012 13:14:59 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=10&rev2=11

Comment:
cleanup for readthedocs

   * The [[https://wiki.apache.org/couchdb/|CouchDB Wiki]] (you're here)
   * The [[http://guide.couchdb.org/draft/index.html|Definitive Guide]], which you can edit/fork/contribute
to.
   * The official [[https://git-wip-us.apache.org/repos/asf?p=couchdb.git;a=tree;f=share/docs;hb=docs|source]]
now has a working {{{docs}}} branch
+  * The ASF [[https://github.com/apache/couchdb/tree/docs|github mirror]] now has a working
{{{docs}}} branch too - get forking!
  
  We welcome your contributions to any of these - if you need help, just ask in IRC, or on
the user email list. Thanks!
  
@@ -29, +30 @@

  -D release='$ver-git-sha' \
  -D project='Apache CouchDB' \
  -D copyright='$year, Apache Software Foundation' \
+ -d $TMPDIR/couchdocs/ \
- -c `pwd` \
- -d /tmp/ \
  rst/ \
  `pwd`/manual
  }}}
@@ -66, +66 @@

  
  Now that you've got a suitable branch selected
  
-  * Browse into {{{share/docs/sphinx-docs}}}
+  * Browse into {{{share/docs/rst}}}
   * Identify the file you want to edit/alter.
  
  {{attachment:github_rst_formatted_view.png}}
@@ -106, +106 @@

  {{{
  cd $MY_COUCH_SOURCE_REPO
  source ./env/bin/activate
- cd share/sphinx-docs
+ cd share/docs
  }}}
  
   * Ensure that you don't have any other pending doc changes by running {{{make changed}}}.
Output should be similar to this:
@@ -115, +115 @@

  Making output directory...
  Running Sphinx v1.1.3
  loading pickled environment... not yet created
- building [changes]: /Users/dch/repos/couch/git/share/sphinx-docs/build/changes
+ building [changes]: /Users/dch/repos/couch/git/share/docs/build/changes
  updating environment: 25 added, 0 changed, 0 removed
  reading sources... [100%] views
  looking for now-outdated files... none found
@@ -125, +125 @@

  build succeeded.
  }}}
  
-  * Update copyright, release and version fields in {{{/share/docs/sphinx-docs/conf.py}}}
+  * Update copyright, release and version fields in {{{/share/docs/rst/conf.py}}}
  
   * Generate targets via:
  
@@ -163, +163 @@

   * TODO: how to distribute updates to CouchDB core website?
   * TODO: again, this should be part of main Makefile
   * TODO: update copyright, version and release updates from core Makefile
+  * TODO: get http://readthedocs.org/ and the ASF docs branch playing nicely
  

Mime
View raw message