This GitLab instance will be migrated to gitlab.mel.vin before 2020-06-01 and will lose the shared runners, setup your own runners if needed.

Commit 66f045b2 authored by Stefan Schrijvers's avatar Stefan Schrijvers

Merge branch '105-missing-search-for-sphinx_rtd_theme-python-module' into 'master'

Resolve "missing search for sphinx_rtd_theme python module"

Closes #105

See merge request c!87
parents e86c33f1 f4a03f5c
......@@ -16,12 +16,18 @@ else()
endif()
# if the target is doxygen build only only doxygen HTML
if(${DOC} STREQUAL "doxygen")
if(DOC STREQUAL "doxygen")
set(DOXY_BUILD_HTML "YES")
set(DOXY_BUILD_XML "NO")
set(DOXY_OUTPUT_DIR "${DOC_DEST}")
# otherwise generate only XML and configure sphinx
else()
if(DOC STREQUAL "html")
set(EXTRA_PYTHON_MODULES "sphinx_rtd_theme")
else()
unset(EXTRA_PYTHON_MODULES)
endif()
set(DOXY_BUILD_HTML "NO")
set(DOXY_BUILD_XML "YES")
set(DOXY_OUTPUT_DIR "${DOC_TMP}/doxygen")
......@@ -44,7 +50,11 @@ else()
OUTPUT_VARIABLE PYTHONPATH)
endif()
foreach(module breathe sphinx sphinxcontrib.plantuml)
foreach(module
breathe
sphinx
sphinxcontrib.plantuml
${EXTRA_PYTHON_MODULES})
string(TOUPPER "${module}" module_upper)
find_python_module("${module}" "${module_upper}")
set(PYTHONPATH "${${module_upper}_PATH}:${PYTHONPATH}")
......@@ -70,7 +80,7 @@ configure_file(
"${DOC_TMP}/doxygen/doxyfile"
@ONLY)
if(${DOC} STREQUAL "doxygen")
if(DOC STREQUAL "doxygen")
add_custom_target(doc
COMMAND Doxygen::doxygen "${DOC_TMP}/doxygen/doxyfile"
COMMENT "Generating HTML API documentation with Doxygen")
......
......@@ -12,5 +12,6 @@ is reStructuredText, usually abbreviated to RST.
Some good documentation to start writing in RST:
* http://www.sphinx-doc.org/en/stable/tutorial.html
* https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/directives.html
* http://docutils.sourceforge.net/rst.html
* https://thomas-cokelaer.info/tutorials/sphinx/rest_syntax.html
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment