Changeset 11386 for main/waeup.kofa/trunk/docs/source/userdocs/buildingdocs.rst

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:

• main/waeup.kofa/trunk/docs/source/userdocs/buildingdocs.rst (modified) (4 diffs)

main/waeup.kofa/trunk/docs/source/userdocs/buildingdocs.rst

@@ -4 +4 @@
 **************************************
 
-To build the documentation for :mod:`waeup.kofa`, please follow these steps:
+We use the excellent `Sphinx <http://sphinx.pocoo.org/>`_ Python
+documentation generator to generate the docs as HTML pages.
 
 Prerequisites
@@ -16 +17 @@
 ==================
 
-After successful install go to the root dir, where `waeup.kofa` is
-located.
+The documentation of the :mod:`waeup.kofa` project can easily be
+created doing::
 
-There run::
+  $ bin/waeupdocs
 
-   $ ./bin/waeupdocs
+This will create a tree of HTML pages in
+``docs/build/html`` which you can for
+instance browse by pointing your browser to this location.
 
-This will (re-)generate any needed docs.
-
-The output can be found in ``docs/build/html``.
+An 'official' place in internet for the whole docs is about to come
+but not yet available.
 
 Actually, ``waeupdocs`` is only a wrapper script around the real main
@@ -37 +39 @@
 Run::
 
-   $ ./bin/sphinx-build --help
+   $ bin/sphinx-build --help
 
 to get a list of options available.
@@ -52 +54 @@
 and more with a short explanation for each format.
 
-
 Building PDF docs
 =================