We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
1 parent 81202ac commit 2c4635eCopy full SHA for 2c4635e
docs/README.md
@@ -0,0 +1,21 @@
1
+# Documentation
2
+
3
+Building the documentation has the following prerequisites:
4
5
+doxygen (www.doxygen.org)
6
+sphinx (www.sphinx-doc.org)
7
+breathe (https://github.com/michaeljones/breathe)
8
9
+Doxygen should be installed and found within the PATH environment variable.
10
+Sphinx should be installed and found within the PATH environment variable.
11
+Breathe is a python module and is expected to be found on the PYTHONPATH environment variable.
12
13
+To build the documentation into a set of html files:
14
15
+make html
16
17
+The documentation index page will be located at:
18
19
+./build/html/index.html
20
21
0 commit comments