shadps4-emu/ext-fmt
1
0
Fork 0
mirror of https://github.com/shadps4-emu/ext-fmt.git synced 2024-12-02 15:26:58 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add building the documentation section

Browse Source
This commit is contained in:
vitaut 2015-10-17 08:17:32 -07:00
parent 5898720c28
commit 826edabae1
1 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/usage.rst
View File

@ -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
===========