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 Sat, 27 Oct 2012 11:56:21 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=26&rev2=27

   * The official [[http://docutils.sourceforge.net/docs/user/rst/quickstart.html|quick start
guide]]
   * A [[http://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html|cheatsheet]] for both
Sphinx and rst
   * If you want to regenerate the documentation into HTML, the [[http://sphinx.pocoo.org/index.html|Sphinx]]
guide may be of interest
+ 
+ == Adding Version Added/Changed or Deprecated Information ==
+ 
+ Sphinx supports [[http://sphinx.pocoo.org/markup/para.html#directive-versionadded|paragraph-level
annotations for tracking when functionality was modified]]. By adding this information directly
to the .rst documentation during committing any functionality, future NEWS and CHANGES updates
can be directly extracted from Sphinx. 
  
  = Editing Documentation via GitHub =
  

Mime
View raw message