kyle
/
wrmath
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add Doxygen conf to sphinx.

This commit is contained in:
Kyle Isom 2019-08-07 20:50:55 -07:00
parent dca6338228
commit 5bee57a2e4
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/sphinx/conf.py
View File

@ -70,8 +70,11 @@ exhale_args = {
"doxygenStripFromPath": "..", "doxygenStripFromPath": "..",
# Suggested optional arguments # Suggested optional arguments
"createTreeView": True, "createTreeView": True,
#"exhaleExecutesDoxygen": True, "exhaleExecutesDoxygen": True,
#"exhaleDoxygenStdin": "INPUT = ../include" "exhaleDoxygenStdin": """
INPUT = ../../include ../../src
USE_XML = YES
"""
} }
# Tell sphinx what the primary language being documented is. # Tell sphinx what the primary language being documented is.

2
docs/sphinx/overview.rst
View File

@ -22,6 +22,6 @@ Important classes
----------------- -----------------
The foundational class of this library (and here's to a real mathematical The foundational class of this library (and here's to a real mathematical
workhorse) is the :class:`wr::geom::Vector`` class. workhorse) is the :class:`wr::geom::Vector` class.
Other important classes are the :class:`wr::geom::Quaternion` class. Other important classes are the :class:`wr::geom::Quaternion` class.