From 5bee57a2e40c6334b07275dfbaede0aa585595e8 Mon Sep 17 00:00:00 2001 From: Kyle Isom Date: Wed, 7 Aug 2019 20:50:55 -0700 Subject: [PATCH] Add Doxygen conf to sphinx. --- docs/sphinx/conf.py | 7 +++++-- docs/sphinx/overview.rst | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/sphinx/conf.py b/docs/sphinx/conf.py index c724b97..2d9eb7c 100644 --- a/docs/sphinx/conf.py +++ b/docs/sphinx/conf.py @@ -70,8 +70,11 @@ exhale_args = { "doxygenStripFromPath": "..", # Suggested optional arguments "createTreeView": True, - #"exhaleExecutesDoxygen": True, - #"exhaleDoxygenStdin": "INPUT = ../include" + "exhaleExecutesDoxygen": True, + "exhaleDoxygenStdin": """ +INPUT = ../../include ../../src +USE_XML = YES +""" } # Tell sphinx what the primary language being documented is. diff --git a/docs/sphinx/overview.rst b/docs/sphinx/overview.rst index b42f7db..58c60c8 100644 --- a/docs/sphinx/overview.rst +++ b/docs/sphinx/overview.rst @@ -22,6 +22,6 @@ Important classes ----------------- 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.