| Rev | Line | |
|---|
| [5340] | 1 | .. _building_documentation: |
|---|
| 2 | |
|---|
| 3 | Building Documentation |
|---|
| 4 | ********************** |
|---|
| 5 | |
|---|
| 6 | To build the documentation for :mod:`waeup.sirp`, please follow these steps: |
|---|
| 7 | |
|---|
| 8 | Prerequisites |
|---|
| 9 | ============= |
|---|
| 10 | |
|---|
| 11 | We assume you already installed `waeup.sirp` as explained in |
|---|
| 12 | :ref:`installing`. You ran ``bin/buildout`` and can find a script |
|---|
| 13 | ``bin/waeupdocs``. |
|---|
| 14 | |
|---|
| 15 | Building HTML docs |
|---|
| 16 | ================== |
|---|
| 17 | |
|---|
| 18 | After successful install go to the root dir, where `waeup.sirp` is |
|---|
| 19 | located. |
|---|
| 20 | |
|---|
| 21 | There run:: |
|---|
| 22 | |
|---|
| 23 | $ ./bin/waeupdocs |
|---|
| 24 | |
|---|
| 25 | This will (re-)generate any needed docs. |
|---|
| 26 | |
|---|
| 27 | The output can be found in ``docs/build/html``. |
|---|
| 28 | |
|---|
| 29 | Alternatively, you can also go to ``docs/build`` and run:: |
|---|
| 30 | |
|---|
| 31 | $ make html |
|---|
| 32 | |
|---|
| 33 | Actually, ``waeupdocs`` is only a wrapper script around the real main |
|---|
| 34 | script ``sphinx-build``, which should also be located in your ``bin/`` |
|---|
| 35 | directory. |
|---|
| 36 | |
|---|
| 37 | You therefore can also run ``bin/spinx-build`` manually, which will |
|---|
| 38 | give you more options, especially, if you want the output to be |
|---|
| 39 | created in a different location or similar. |
|---|
| 40 | |
|---|
| 41 | Building PDF docs |
|---|
| 42 | ================= |
|---|
| 43 | |
|---|
| 44 | We're currently not prepared for PDF, but support is already planned. |
|---|
| 45 | |
|---|
| 46 | Please be aware, that any PDF support will require a full TeX |
|---|
| 47 | installation on your system to work. |
|---|
Note: See
TracBrowser for help on using the repository browser.
