You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@couchdb.apache.org by Michael McDaniel <co...@autosys.us> on 2008/12/30 19:28:39 UTC
documentation
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
--
Michael McDaniel
Portland, Oregon, USA
http://autosys.us
http://trip.autosys.us
Re: documentation
Posted by Noah Slater <ns...@apache.org>.
Thanks muchly.
On Tue, Dec 30, 2008 at 01:39:37PM -0800, Michael McDaniel wrote:
> entered for Build System, key = COUCHDB-187
>
> On Tue, Dec 30, 2008 at 08:38:40PM +0000, Noah Slater wrote:
> > 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
Re: documentation
Posted by Michael McDaniel <co...@autosys.us>.
entered for Build System, key = COUCHDB-187
On Tue, Dec 30, 2008 at 08:38:40PM +0000, Noah Slater wrote:
> 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
--
Michael McDaniel
Portland, Oregon, USA
http://autosys.us
+1 503 283 5284
Re: documentation
Posted by Noah Slater <ns...@apache.org>.
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