couchdb-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Paul Joseph Davis (JIRA)" <j...@apache.org>
Subject [jira] Closed: (COUCHDB-187) suggestion to add html document creation to build system
Date Sat, 09 Oct 2010 20:01:37 GMT

     [ https://issues.apache.org/jira/browse/COUCHDB-187?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Paul Joseph Davis closed COUCHDB-187.
-------------------------------------

    Resolution: Duplicate

Duplicate of COUCHDB-146

> suggestion to add html document creation to build system
> --------------------------------------------------------
>
>                 Key: COUCHDB-187
>                 URL: https://issues.apache.org/jira/browse/COUCHDB-187
>             Project: CouchDB
>          Issue Type: Improvement
>          Components: Build System
>         Environment: GNU/Linux with Erlang, CouchDB
>            Reporter: Michael McDaniel
>            Priority: Minor
>   Original Estimate: 4h
>  Remaining Estimate: 4h
>
> >  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      
                    
> >    

-- 
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.


Mime
View raw message