Mailing-List: contact commits-help@couchdb.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@couchdb.apache.org
MIME-Version: 1.0
Content-Type: text/plain; charset="utf-8"
Content-Transfer-Encoding: quoted-printable
From: Apache Wiki <wikidiffs@apache.org>
To: Apache Wiki <wikidiffs@apache.org>
Date: Wed, 26 Sep 2012 13:14:59 -0000
Message-ID: <20120926131459.85528.42068@eos.apache.org>
Subject: 
 =?utf-8?q?=5BCouchdb_Wiki=5D_Trivial_Update_of_=22Documentation=22_by_Dav?=
 =?utf-8?q?eCottlehuber?=
Auto-Submitted: auto-generated

Dear Wiki user,

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

The "Documentation" page has been changed by DaveCottlehuber:
http://wiki.apache.org/couchdb/Documentation?action=3Ddiff&rev1=3D10&rev2=
=3D11

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]], wh=
ich you can edit/fork/contribute to.
   * The official [[https://git-wip-us.apache.org/repos/asf?p=3Dcouchdb.git=
;a=3Dtree;f=3Dshare/docs;hb=3Ddocs|source]] now has a working {{{docs}}} br=
anch
+  * 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 as=
k in IRC, or on the user email list. Thanks!
  =

@@ -29, +30 @@

  -D release=3D'$ver-git-sha' \
  -D project=3D'Apache CouchDB' \
  -D copyright=3D'$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/ch=
anges
+ 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/con=
f.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 nice=
ly
 =20