Changeset 5344 for main/waeup.sirp/trunk/docs/source

Timestamp:

29 Jul 2010, 23:08:04 (14 years ago)

Author:

uli

Message:

Update docs.

Location:

main/waeup.sirp/trunk/docs/source

Files:

• developerdocs/api/index.rst (modified) (1 diff)
• userdocs/buildingdocs.rst (modified) (1 diff)

main/waeup.sirp/trunk/docs/source/developerdocs/api/index.rst

@@ -7 +7 @@
 .. toctree::
 
-   
+   api_app

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

@@ -27 +27 @@
 The output can be found in ``docs/build/html``.
 
+Actually, ``waeupdocs`` is only a wrapper script around the real main
+script ``sphinx-build``, which should also be located in your ``bin/``
+directory.
+
+You therefore can also run ``bin/sphinx-build`` manually, which will
+give you more options, especially, if you want the output to be
+created in a different location or similar.
+
+Run::
+
+   $ ./bin/sphinx-build --help
+
+to get a list of options available.
+
 Alternatively, you can also go to ``docs/build`` and run::
 
    $ make html
 
-Actually, ``waeupdocs`` is only a wrapper script around the real main
-script ``sphinx-build``, which should also be located in your ``bin/``
-directory.
+Other available formats are listed, when you run only::
 
-You therefore can also run ``bin/spinx-build`` manually, which will
-give you more options, especially, if you want the output to be
-created in a different location or similar.
+   $ make
+
+These other formats will include ``latex``, ``doctest``, ``linkcheck``
+and more with a short explanation for each format.
+
 
 Building PDF docs