Skip to content

Commit

Permalink
Update help string for TriBITS_ENABLE_DOC_GENERATION_TESTS
Browse files Browse the repository at this point in the history
I added mention of needing to install sphinx and sphinx-rd-theme in order to
run the sphinx-based tests.
  • Loading branch information
bartlettroscoe committed Aug 1, 2024
1 parent 6958311 commit 1cee30f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion test/doc/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ endif()

advanced_set( ${PROJECT_NAME}_ENABLE_DOC_GENERATION_TESTS OFF
CACHE BOOL
"Enable testing for the build of the documentation. Requires docutils and will blow away and rebuild the existing documentation in the source tree since the documentation builds in place." )
"Enable testing for the build of the documentation, including using Sphinx. Requires docutils, sphinx, and sphinx-rd-theme and will blow away and rebuild the existing documentation in the source tree since the documentation builds in place. Therefore, one must be careful to not blow away non-tracked files." )


tribits_add_advanced_test( sphinx_rst_generator_UnitTests
Expand Down

0 comments on commit 1cee30f

Please sign in to comment.