Ignore:
Timestamp:
24 Feb 2014, 06:43:26 (11 years ago)
Author:
Henrik Bettermann
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • main/waeup.kofa/trunk/docs/source/userdocs/buildingdocs.rst

    r7808 r11386  
    44**************************************
    55
    6 To build the documentation for :mod:`waeup.kofa`, please follow these steps:
     6We use the excellent `Sphinx <http://sphinx.pocoo.org/>`_ Python
     7documentation generator to generate the docs as HTML pages.
    78
    89Prerequisites
     
    1617==================
    1718
    18 After successful install go to the root dir, where `waeup.kofa` is
    19 located.
     19The documentation of the :mod:`waeup.kofa` project can easily be
     20created doing::
    2021
    21 There run::
     22  $ bin/waeupdocs
    2223
    23    $ ./bin/waeupdocs
     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.
    2427
    25 This will (re-)generate any needed docs.
    26 
    27 The output can be found in ``docs/build/html``.
     28An 'official' place in internet for the whole docs is about to come
     29but not yet available.
    2830
    2931Actually, ``waeupdocs`` is only a wrapper script around the real main
     
    3739Run::
    3840
    39    $ ./bin/sphinx-build --help
     41   $ bin/sphinx-build --help
    4042
    4143to get a list of options available.
     
    5254and more with a short explanation for each format.
    5355
    54 
    5556Building PDF docs
    5657=================
Note: See TracChangeset for help on using the changeset viewer.