docs: Enabling sphinx-based documentation and styling docs closer to named-data.net
Change-Id: Id80e0a4ba6f307159d4dcfdd7796189316a0c566
Refs: #1251
diff --git a/INSTALL.md b/INSTALL.md
index 63f3c87..8abbcc8 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -24,17 +24,22 @@
sudo apt-get install libpcap-dev
-To build API documentation:
+To build manpages and API documentation:
* `doxygen`
+* `graphviz`
+* `python-sphinx`
On Mac OS X 10.8 and 10.9 with macports:
- sudo port install doxygen
+ sudo port install doxygen graphviz py27-sphinx sphinx_select
+ sudo port select sphinx py27-sphinx
On Ubuntu >= 12.04:
- sudo apt-get install doxygen
+ sudo apt-get install doxygen graphviz python-sphinx
+
+
## Build
@@ -52,3 +57,14 @@
./waf configure
./waf
sudo ./waf install
+
+# Building API documentation
+
+The following commands can be used to build API documentation in `build/docs/doxygen`
+
+ ./waf doxygen
+
+Note that manpages are automatically created and installed during the normal build process (e.g., during `./waf` and `./waf install`), if `python-sphinx` module is detected during `./waf configure` stage.
+By default, manpages are installed into `${PREFIX}/share/man` (where default value for `PREFIX` is `/usr/local`).
+This location can be changed during `./waf configure` stage using `--prefix`, `--datarootdir`, or `--mandir` options.
+For more details, refer to `./waf --help`.