source: main/waeup.kofa/trunk/docs/source/userdocs/buildingdocs.rst @ 14684

Last change on this file since 14684 was 11386, checked in by Henrik Bettermann, 11 years ago

Update INSTALL.txt and integrate into Sphinx documentation. Remove redundancies.

File size: 1.6 KB
RevLine 
[5340]1.. _building_documentation:
2
[6619]3Building Documentation (Linux OS only)
4**************************************
[5340]5
[11386]6We use the excellent `Sphinx <http://sphinx.pocoo.org/>`_ Python
7documentation generator to generate the docs as HTML pages.
[5340]8
9Prerequisites
10=============
11
[7808]12We assume you already installed `waeup.kofa` as explained in
[6619]13:ref:`installing_linux`. You ran ``bin/buildout`` and can find a script
[5340]14``bin/waeupdocs``.
15
16Building HTML docs
17==================
18
[11386]19The documentation of the :mod:`waeup.kofa` project can easily be
20created doing::
[5340]21
[11386]22  $ bin/waeupdocs
[5340]23
[11386]24This will create a tree of HTML pages in
25``docs/build/html`` which you can for
26instance browse by pointing your browser to this location.
[5340]27
[11386]28An 'official' place in internet for the whole docs is about to come
29but not yet available.
[5340]30
31Actually, ``waeupdocs`` is only a wrapper script around the real main
32script ``sphinx-build``, which should also be located in your ``bin/``
33directory.
34
[5344]35You therefore can also run ``bin/sphinx-build`` manually, which will
[5340]36give you more options, especially, if you want the output to be
37created in a different location or similar.
38
[5344]39Run::
40
[11386]41   $ bin/sphinx-build --help
[5344]42
43to get a list of options available.
44
45Alternatively, you can also go to ``docs/build`` and run::
46
47   $ make html
48
49Other available formats are listed, when you run only::
50
51   $ make
52
53These other formats will include ``latex``, ``doctest``, ``linkcheck``
54and more with a short explanation for each format.
55
[5340]56Building PDF docs
57=================
58
59We're currently not prepared for PDF, but support is already planned.
60
61Please be aware, that any PDF support will require a full TeX
62installation on your system to work.
Note: See TracBrowser for help on using the repository browser.