Changes between Initial Version and Version 1 of DocumentationGeneration


Ignore:
Timestamp:
09/23/2008 01:25:31 AM (9 years ago)
Author:
trac
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DocumentationGeneration

    v1 v1  
     1{{{ 
     2#!rst 
     3Documentation generation 
     4======================== 
     5 
     6HTML documentation 
     7------------------ 
     8 
     9The Nagare documentation is written in 
     10the `reStrucuturedText <http://docutils.sourceforge.net/rst.html>`_ format. 
     11 
     12If you want it in HTML, first do a developer installation as described in 
     13:wiki:`NagareInstallation#developers-framework-installation`, then go to the 
     14``nagare/core`` directory and enter the command: 
     15 
     16.. code-block:: sh 
     17 
     18   <NAGARE_HOME>/bin/python setup.py generate_html docs/*.txt 
     19 
     20The HTML documentation is generated into the ``nagare/core/docs/html`` directory. 
     21 
     22API documentation 
     23----------------- 
     24 
     25If you want an HTML extraction of the Nagare classes and API, first do a 
     26developer installation as described in 
     27:wiki:`NagareInstallation#developers-framework-installation`, then go to the 
     28``nagare/core`` directory and enter the command: 
     29 
     30.. code-block:: sh 
     31 
     32   <NAGARE_HOME>/bin/python setup.py generate_api 
     33 
     34The HTML documentation is generated into the ``nagare/core/docs/api`` directory 
     35(start with the ``index.html`` file). 
     36 
     37.. wikiname: DocumentationGeneration 
     38 
     39 
     40 
     41}}}