Edgewall Software

Changes between Version 15 and Version 16 of TracDev/ApiDocs


Ignore:
Timestamp:
Sep 8, 2012, 6:34:50 PM (12 years ago)
Author:
Christian Boos
Comment:

updated for 0.12.4, 1.0, 1.0-stable and trunk (use a table now)

Legend:

Unmodified
Added
Removed
Modified

  • TracDev/ApiDocs

    v15 v16  
    55== View the documentation
    66
    7 Besides the TracBrowser and looking directly at the code, you can also read the generated API documentation, which only shows the public API in a nicely organized and rendered way:
     7Besides the TracBrowser and looking directly at the code, you can also read the generated API documentation, which shows the public API in a nicely organized and rendered way:
    88
    9 {{{#!div style="background: #ffd; margin: 2em; border: outset #eec 2px; line-height: 2em;"
    10  - **Trac 1.0dev:** [http://www.edgewall.org/docs/trac-trunk/epydoc/ apiref] | **[http://www.edgewall.org/docs/trac-trunk/html/ apidoc HTML]** | [http://www.edgewall.org/docs/trac-trunk/pdf/trac_dev.pdf apidoc PDF]
    11  - Trac 0.12: ''apiref'' for [http://www.edgewall.org/docs/tags-trac-0.12/epydoc/ 0.12] | [http://www.edgewall.org/docs/tags-trac-0.12.1/epydoc/ 0.12.1] | [http://www.edgewall.org/docs/tags-trac-0.12.2/epydoc/ 0.12.2] | [http://www.edgewall.org/docs/tags-trac-0.12.3/epydoc/ 0.12.3] | [http://www.edgewall.org/docs/tags-trac-0.12.4rc1/epydoc/ 0.12.4rc1] | [http://www.edgewall.org/docs/branches-0.12-stable/epydoc/ 0.12-stable]
    12  - Trac 0.11: ''apiref'' for [http://www.edgewall.org/docs/tags-trac-0.11.7/epydoc/ 0.11.7]
     9{{{#!table style="background: #ffd; margin: 2em;"
     10
     11{{{#!th rowspan=2
     12Line of development
    1313}}}
    14 
     14||||= **Sphinx documentation** (`apidoc`) || \
     15{{{#!th rowspan=2
     16Epydoc (`apiref`)
     17}}}
     18|-
     19||= HTML ||= PDF ||
     20|-
     21||= Trac 1.1.//x// (trunk) || \
     22|| //[http://www.edgewall.org/docs/trac-trunk/html/ trunk]// || \
     23|| //[http://www.edgewall.org/docs/trac-trunk/pdf/trac_dev.pdf trunk]// || \
     24|| //[http://www.edgewall.org/docs/trac-trunk/epydoc/trac-module.html trunk]// ||
     25|-
     26||= **Trac 1.0** || \
     27|| [http://www.edgewall.org/docs/tags-trac-1.0/html/ 1.0] | //[http://www.edgewall.org/docs/branches-1.0-stable/html/ 1.0-stable]// || \
     28|| [http://www.edgewall.org/docs/branches-1.0-stable/pdf/trac_dev.pdf 1.0] | //[http://www.edgewall.org/docs/tags-trac-1.0/pdf/trac_dev.pdf 1.0-stable]// || \
     29|| [http://www.edgewall.org/docs/tags-trac-1.0/epydoc/trac-module.html 1.0] | //[http://www.edgewall.org/docs/branches-1.0-stable/epydoc/trac-module.html 1.0-stable]// ||
     30|-
     31||= Trac 0.12 || \
     32|| || || [http://www.edgewall.org/docs/tags-trac-0.12/epydoc/trac-module.html 0.12] | [http://www.edgewall.org/docs/tags-trac-0.12.1/epydoc/trac-module.html 0.12.1] | [http://www.edgewall.org/docs/tags-trac-0.12.2/epydoc/trac-module.html 0.12.2] | [http://www.edgewall.org/docs/tags-trac-0.12.3/epydoc/trac-module.html 0.12.3] | [http://www.edgewall.org/docs/tags-trac-0.12.4/epydoc/trac-module.html 0.12.4] | //[http://www.edgewall.org/docs/branches-0.12-stable/epydoc/trac-module.html 0.12-stable]// ||
     33|-
     34||= Trac 0.11 || \
     35|| || || [http://www.edgewall.org/docs/tags-trac-0.11.7/epydoc/trac-module.html 0.11.7] ||
     36}}}
     37    //(in italic: corresponds to the latest revision on the branch)//
    1538
    1639 apiref :: Full API reference, generated using [http://epydoc.sourceforge.net/ epydoc]. \\
    … …  
    2245For now, the two sets of documentations are complementary. One day the Sphinx documentation will be complete and sufficient, at which point we'll probably drop the epydoc part (besides, epydoc itself doesn't seem to be maintained anymore).
    2346
    24 Note that as Trac 0.11 and 0.12 were not really prepared for being processed, the quality of the generated documentation is all but perfect. It's not that the one for 0.13dev is, but there we're working on it. The 0.12-stable link and the 0.13dev links above should correspond to the latest version of the corresponding branch.
     47Note that as Trac 0.11 and 0.12 were not really prepared for being processed, the quality of the generated documentation is all but perfect. It's not that the one for 1.0 is, but starting from there, we're actively working on it.
    2548
    2649== Generating the documentation
    … …  
    3861=== Sphinx — `make apidoc`
    3962
    40 Once you have installed `sphinx`, go to your Trac trunk checkout and do:
     63Once you have installed `sphinx`, go to your Trac 1.0-stable or trunk checkout and do:
    4164{{{
    4265$ make apidoc-html