diff options
author | vitaut <victor.zverovich@gmail.com> | 2015-10-17 08:17:32 -0700 |
---|---|---|
committer | vitaut <victor.zverovich@gmail.com> | 2015-10-17 08:17:32 -0700 |
commit | 826edabae10fd14aae12c4d29049e4c7b0f2fc3e (patch) | |
tree | 5a7c8628b912cce7f50c32665b6e4150f3b05a9c /doc/usage.rst | |
parent | 5898720c282e24be6e05b31592204b3515812759 (diff) | |
download | fmtlib-826edabae10fd14aae12c4d29049e4c7b0f2fc3e.tar.gz |
Add building the documentation section
Diffstat (limited to 'doc/usage.rst')
-rw-r--r-- | doc/usage.rst | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/doc/usage.rst b/doc/usage.rst index ea3e43be..3d900ff6 100644 --- a/doc/usage.rst +++ b/doc/usage.rst @@ -54,6 +54,23 @@ To build a `shared library`__ set the ``BUILD_SHARED_LIBS`` CMake variable to __ http://en.wikipedia.org/wiki/Library_%28computing%29#Shared_libraries +Building the documentation +========================== + +To build the documentation you need the following software installed on your +system: + +* [Python](https://www.python.org/) with pip and virtualenv +* [Doxygen](http://www.stack.nl/~dimitri/doxygen/) +* [Less](http://lesscss.org/) with less-plugin-clean-css + +First generate makefiles or project files using CMake as described in +previous section. Then compile the ``doc`` target/project, for example:: + + make doc + +This will generate HTML documenation in ``doc/html``. + Android NDK =========== |