Edgewall Software

Changes between Version 4 and Version 5 of TracDev/ApiDocs


Ignore:
Timestamp:
Nov 19, 2010, 3:04:06 PM (13 years ago)
Author:
Christian Boos
Comment:

updated for r10337

Legend:

Unmodified
Added
Removed
Modified
  • TracDev/ApiDocs

    v4 v5  
    3838Once you have installed `sphinx`, go to your Trac trunk checkout and do:
    3939{{{
    40 $ make apidoc
     40$ make apidoc-html
    4141}}}
    4242This will generate the `Sphinx` documentation in `./build/doc/html` (start with the `index.html` page).
    4343
    44 Alternatively, you can also generate a PDF document using [http://rst2pdf.googlecode.com rst2pdf]:
     44You can also generate a PDF document using [http://rst2pdf.googlecode.com rst2pdf]:
    4545{{{
    46 $ make apidoc sphinxformat=pdf
     46$ make apidoc-pdf
    4747}}}
    4848This will generate the `./build/doc/pdf/trac_dev.pdf` file.
     49
     50Alternatively you can invoke `make apidoc` to get both.
    4951
    5052Sphinx is a no brainer `easy_install sphinx` installation, which will get you the appropriate dependencies (docutils and jinja2).