Commit 0a860c94 authored by Lukas Riedel's avatar Lukas Riedel 📝

install Sphinx into venv and create docs with it. links for builddir files are...

install Sphinx into venv and create docs with it. links for builddir files are not working. removed dune-cmake module
parent 2bac83d8
...@@ -3,28 +3,21 @@ message(STATUS "Python modules path: ${DORIE_PYTHON_MODULES}") ...@@ -3,28 +3,21 @@ message(STATUS "Python modules path: ${DORIE_PYTHON_MODULES}")
add_subdirectory("doxygen") add_subdirectory("doxygen")
add_subdirectory("default_files") add_subdirectory("default_files")
# copy static files to build tree message(STATUS "Installing requirements for documentation")
file(COPY ${CMAKE_CURRENT_LIST_DIR}/examples DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) set(INSTALL_CMD -m pip install -r ${CMAKE_CURRENT_SOURCE_DIR}/requirements.txt)
file(COPY ${CMAKE_CURRENT_LIST_DIR}/figures DESTINATION ${CMAKE_CURRENT_BINARY_DIR}) dune_execute_process(COMMAND "${DUNE_PYTHON_VIRTUALENV_EXECUTABLE}" "${INSTALL_CMD}"
ERROR_MESSAGE "Error installing Documentation dependencies into virtualenv!")
include(DuneSphinxCMakeDoc) configure_file(conf.py.in ${CMAKE_CURRENT_SOURCE_DIR}/conf.py)
dune_cmake_sphinx_doc(SPHINX_CONF ${CMAKE_CURRENT_SOURCE_DIR}/conf.py.in
RST_SOURCES
index.rst
doxygen-guide.rst
doxygen-modules.rst
doxygen-quick-all.rst
logs-install.rst
other-cmake.rst
python-dorie-parscraper.rst
python-dorie-testtools.rst
python-dorie-utilities.rst
quickstart-bcfile.rst
quickstart-cookbook.rst
quickstart-installation.rst
quickstart-parameters.rst
MODULE_ONLY)
if(TARGET sphinx_html) set(SPHINX_EXECUTABLE ${DUNE_PYTHON_VIRTUALENV_PATH}/bin/sphinx-build)
add_dependencies(sphinx_html doxygen_dorie) add_custom_target(sphinx_html
endif() COMMAND ${SPHINX_EXECUTABLE}
-b html
-w ${CMAKE_BINARY_DIR}/SphinxError.log
-c ${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_SOURCE_DIR}
${CMAKE_CURRENT_BINARY_DIR}/html
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
add_dependencies(sphinx_html doxygen_dorie)
\ No newline at end of file
...@@ -54,7 +54,6 @@ extensions = [ ...@@ -54,7 +54,6 @@ extensions = [
'sphinx.ext.mathjax', 'sphinx.ext.mathjax',
'sphinx.ext.ifconfig', 'sphinx.ext.ifconfig',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx_cmake_dune',
'breathe' 'breathe'
] ]
......
Sphinx
breathe
sphinx_rtd_theme
\ No newline at end of file
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