Build sphinx/doxygen docs with CMake #201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* The DOCS CMake option runs doxygen and sphinx to build the html documentation. Default if OFF. If ON, it requires doxygen and sphinx to be installed (found via FindSphinx.cmake). * Describe the documentation generation option in INSTALL.md. * Fix broken references in half.rst. * Remove quotes around some template function names in doxygen comments that result in unresolved references. Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Closed
lgritz
reviewed
Aug 20, 2021
| @@ -872,6 +872,8 @@ typedef Vec4<double> V4d; | |||
| // Normalize and length don't make sense for integer vectors, so disable them. | |||
| //---------------------------------------------------------------------------- | |||
|
|
|||
| /// @cond Doxygen_Suppress | |||
There was a problem hiding this comment.
Ooh, I didn't know about this!
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
to cary-ilm/Imath
that referenced
this pull request
Aug 30, 2021
* Build sphinx/doxygen docs with CMake * The DOCS CMake option runs doxygen and sphinx to build the html documentation. Default if OFF. If ON, it requires doxygen and sphinx to be installed (found via FindSphinx.cmake). * Describe the documentation generation option in INSTALL.md. * Fix broken references in half.rst. * Remove quotes around some template function names in doxygen comments that result in unresolved references. Signed-off-by: Cary Phillips <cary@ilm.com> * Add copyright/license Signed-off-by: Cary Phillips <cary@ilm.com> * Fix dependencies Signed-off-by: Cary Phillips <cary@ilm.com> * Restore conf.py for RTD Signed-off-by: Cary Phillips <cary@ilm.com> * Fix typo in conf.py for RTD Signed-off-by: Cary Phillips <cary@ilm.com> * typo Signed-off-by: Cary Phillips <cary@ilm.com> * Fix merge Signed-off-by: Cary Phillips <cary@ilm.com> * Remove Doxyfile Signed-off-by: Cary Phillips <cary@ilm.com>
cary-ilm
added a commit
that referenced
this pull request
Sep 1, 2021
* Build sphinx/doxygen docs with CMake * The DOCS CMake option runs doxygen and sphinx to build the html documentation. Default if OFF. If ON, it requires doxygen and sphinx to be installed (found via FindSphinx.cmake). * Describe the documentation generation option in INSTALL.md. * Fix broken references in half.rst. * Remove quotes around some template function names in doxygen comments that result in unresolved references. Signed-off-by: Cary Phillips <cary@ilm.com> * Add copyright/license Signed-off-by: Cary Phillips <cary@ilm.com> * Fix dependencies Signed-off-by: Cary Phillips <cary@ilm.com> * Restore conf.py for RTD Signed-off-by: Cary Phillips <cary@ilm.com> * Fix typo in conf.py for RTD Signed-off-by: Cary Phillips <cary@ilm.com> * typo Signed-off-by: Cary Phillips <cary@ilm.com> * Fix merge Signed-off-by: Cary Phillips <cary@ilm.com> * Remove Doxyfile Signed-off-by: Cary Phillips <cary@ilm.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The DOCS CMake option runs doxygen and sphinx to build the html
documentation. Default if OFF. If ON, it requires doxygen and sphinx
to be installed (found via FindSphinx.cmake).
Describe the documentation generation option in INSTALL.md.
Fix broken references in half.rst.
Remove quotes around some template function names in doxygen
comments that result in unresolved references.
TODO: Something is still wonky here, it looks like doxygen gets invoked twice, and sphinx gets invoked even if nothing has changed, but I'm not sure how to specify the proper dependencies.
Signed-off-by: Cary Phillips cary@ilm.com