couchdb-user mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Noah Slater <nsla...@apache.org>
Subject Re: documentation
Date Tue, 30 Dec 2008 20:38:40 GMT
Could you drop this whole email into a JIRA ticket?

We should put this into the build system.

Thanks,

On Tue, Dec 30, 2008 at 10:28:39AM -0800, Michael McDaniel wrote:
>
>  If you would like to create html documentation of your source-code
>  install, you can do the following ...
>
>  $ cd /path/to/couchdb/src/couchdb
>  $ erl -noshell -eval "edoc:application(couchdb, \".\", [])" -s init stop
>
>  $ cd /path/to/couchdb/src/mochiweb
>  $ erl -noshell -eval "edoc:application(mochiweb, \".\", [])" -s init stop
>
>
>  The erl command will create a  /src/mochiweb/doc and  src/couchdb/doc
>  directory with the html.
>
>
>  edoc had no complaints compiling the documentation as of version
>
>  $ couchdb -V
>  couchdb - Apache CouchDB 0.9.0a729929-incubating
>
>
>  Then, point browser to file:///path/to/couchdb/src/couchdb/doc/index.html
>
>
> ~Michael
> P.S. perhaps a doc/index.html target could be added to Makefiles,
>      something similar to
>
> doc/index.html : $(SRC)
>    erl -noshell -eval "edoc:application(couchdb, \".\", [])" -s init stop
>
>
>

-- 
Noah Slater, http://tumbolia.org/nslater

Mime
View raw message