aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorlloyd <[email protected]>2011-12-17 17:43:15 +0000
committerlloyd <[email protected]>2011-12-17 17:43:15 +0000
commit8b625b242e222044a12e92902548450c2949f0b7 (patch)
treebe173ef031345ed6f059e5269bc4d052d4b1a496 /doc
parent2d4f236f5a829b9900ca1b9cefaba0f0771e5da2 (diff)
Basic instructions for building the docs
Diffstat (limited to 'doc')
-rw-r--r--doc/building.txt22
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/building.txt b/doc/building.txt
index 044e46c3d..e16531de4 100644
--- a/doc/building.txt
+++ b/doc/building.txt
@@ -60,10 +60,11 @@ we might see lines like::
INFO: Skipping, incompatible OS - beos_stats cryptoapi_rng win32_crit_section win32_stats
INFO: Skipping, incompatible compiler - mp_msvc64 mp_x86_32_msvc
-The ones that are 'loaded on request only' have to be explicitly asked
-for, because they rely on third party libraries which your system
-might not have. For instance to enable zlib support, add
-``--with-zlib`` to your invocation of ``configure.py``.
+The ones that are skipped because they are 'by request only' have to
+be explicitly asked for, because they rely on third party libraries
+which your system might not have or that you might not want the
+resulting binary to depend on. For instance to enable zlib support,
+add ``--with-zlib`` to your invocation of ``configure.py``.
You can control which algorithms and modules are built using the
options ``--enable-modules=MODS`` and ``--disable-modules=MODS``, for
@@ -191,6 +192,18 @@ your documentation and/or local expert for details).
Other Build-Related Tasks
----------------------------------------
+.. _building_docs:
+
+Building The Documentation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There are two documentation options available, Sphinx and Doxygen.
+Sphinx will be used if ``sphinx-build`` is detected in the PATH, or if
+``--with-sphinx`` is used at configure time. Doxygen is only enabled
+if ``--with-doxygen`` is used. Both are generated by the makefile
+target ``docs``.
+
+
.. _amalgamation:
The Amalgamation Build
@@ -250,7 +263,6 @@ It may be useful to run multiple builds with different
configurations. Specify ``--build-dir=<dir>`` to set up a build
environment in a different directory.
-
.. _configure_with_python3:
Configuring the Build With Python 3.1