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 NoahSlater
Date Sat, 29 Sep 2012 15:42:23 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 NoahSlater:
http://wiki.apache.org/couchdb/Documentation?action=diff&rev1=21&rev2=22

  Since Python 3.3 release there wouldn't be any requirement for virtualenv since it goes
to be in [[http://docs.python.org/dev/library/venv.html#module-venv|stdlib]] and sphinx is
ready for Python 3.x. ~ Alexander Sh.
  ''
  
- == Generation via Makefile ==
- 
- There is no makefile support yet. It should do the following:
- 
-  * make sure search works
-   * current get an error
-   * "XMLHttpRequest cannot load file://[...]/share/docs/build/html/searchindex.js. Origin
null is not allowed by Access-Control-Allow-Origin."
-  * check sphinx-build is in path
-    * check sphinx, docutils, and pygments are installed
-    * check for a valid tex installation
-    * add note to readme about these being required for docs, like help2man
-    * add an option to ./configure to force failure when dev tools are not available
-    * add this option to the release procedure to make sure it happens
-  * output temporary files outside the build chain using the {{{-d $TMPDIR/somewhere}}} option
-  * output final files into the directory provided as last parameter, currently {{{`pwd`/manual}}}
-  * update release, year, version, as required in the sphinx-build call
-  * handle VPATH correctly
-  * output the HTML documentation into the right place for generating the release tar.gz
artefacts
-  * ensure the futon link does the right thing
- 
  == Generation via ReadTheDocs ==
  
  To regenerate [[http://couchdb.readthedocs.org/|the online docs]], push your changes to
the {{{/docs}}} branch, and then POST to a build-specific URL {{{curl -vX POST http://readthedocs.org/build/4251}}}.
You can track the [[https://readthedocs.org/builds/couchdb/|build progress]] and also grab
the various built [[https://readthedocs.org/projects/couchdb/downloads/|formats]].

Mime
View raw message