diff --git a/docs/config/gen_content.sh.in b/docs/config/gen_content.sh.in index f36d860b4ea4a1c3f7f3e55ae37abd102a5682a9..345d20bfe540fca3248710fd8578cd15ef3b4af4 100755 --- a/docs/config/gen_content.sh.in +++ b/docs/config/gen_content.sh.in @@ -9,7 +9,7 @@ mkdir -p @SPHINX_OUTPUT@/html # Doxygen mkdir -p @DOXYGEN_OUTPUT@ -@DOXYGEN_BIN@ @DOXYGEN_CONFIG@ > @CMAKE_CURRENT_BINARY_DIR@/doxygen.log +@DOXYGEN_BIN@ @DOXYGEN_CONFIG@ > @DOC_BUILD_DIR@/doxygen.log ## SPHINX - DOC ## Documentation files @@ -23,7 +23,7 @@ do cp -r @SPHINX_INPUT_HYSOPDOC@/${dir} @SPHINX_TMP@/. done ## Complete the license.rst with actual LICENSE file content -cat @SPHINX_INPUT_HYSOPDOC@/license.rst @CMAKE_SOURCE_DIR@/LICENSE > @SPHINX_TMP@/license.rst +cat @SPHINX_INPUT_HYSOPDOC@/license.rst @HYSOP_SOURCE_DIR@/LICENSE > @SPHINX_TMP@/license.rst ## API rm -rf @SPHINX_TMP@/apidoc mkdir -p @SPHINX_TMP@/apidoc @@ -31,4 +31,4 @@ mkdir -p @SPHINX_TMP@/apidoc ## Fix the generated files : add path in Sphinx's conf.py seems not enough to find these hysop modules find @SPHINX_TMP@/apidoc -name '*.rst' -exec sed -i'' -E 's/(.. automodule:: )/\1hysop./g' '{}' \; ## Doc pages build -@SPHINX_BIN@ -T -w @CMAKE_CURRENT_BINARY_DIR@/sphinx.log -b ${doc_type} -d @CMAKE_BINARY_DIR@/doctrees -c @SPHINX_CONFIG@ @SPHINX_TMP@ @SPHINX_OUTPUT@/${doc_type} > /dev/null 2>&1 +@SPHINX_BIN@ -T -w @DOC_BUILD_DIR@/sphinx.log -b ${doc_type} -d @DOC_BUILD_DIR@/doctrees -c @SPHINX_CONFIG@ @SPHINX_TMP@ @SPHINX_OUTPUT@/${doc_type} > /dev/null 2>&1 diff --git a/docs/config/hysop.doxyfile.in b/docs/config/hysop.doxyfile.in index 99f570920194231b8ac7989366bbd56bc8624ea6..f01913d6782065a2fcc40ed08889d78491c22c3d 100644 --- a/docs/config/hysop.doxyfile.in +++ b/docs/config/hysop.doxyfile.in @@ -71,7 +71,7 @@ PROJECT_BRIEF = "Particle Methods simulation on hybrid architectures" # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/sphinx_minimal/_static/logo_hysop_couleur.png +PROJECT_LOGO = @SPHINX_TMP@/_static/logo_hysop_couleur.png # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -180,7 +180,7 @@ FULL_PATH_NAMES = NO # will be relative from the directory where doxygen is started. # This tag requires that the tag FULL_PATH_NAMES is set to YES. -STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@ +STRIP_FROM_PATH = @HYSOP_SOURCE_DIR@ # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the # path mentioned in the documentation of a class, which tells the reader which @@ -1219,7 +1219,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = @CMAKE_SOURCE_DIR@/docs/doxygen_layout/header.html +HTML_HEADER = @HYSOP_SOURCE_DIR@/docs/doxygen_layout/header.html # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1229,7 +1229,7 @@ HTML_HEADER = @CMAKE_SOURCE_DIR@/docs/doxygen_layout/header.html # that doxygen normally uses. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_FOOTER = @CMAKE_SOURCE_DIR@/docs/doxygen_layout/footer.html +HTML_FOOTER = @HYSOP_SOURCE_DIR@/docs/doxygen_layout/footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading style # sheet that is used by each HTML page. It can be used to fine-tune the look of diff --git a/docs/config/meson.build b/docs/config/meson.build index ccd2ab9c6f18bb4e0a1c774a05d95fc35c30c793..00458114184e8a5afdb909060882070046901dd8 100644 --- a/docs/config/meson.build +++ b/docs/config/meson.build @@ -3,11 +3,7 @@ years = run_command('date', '+%Y', check: true) conf_doc_data = configuration_data({ 'PROJECT_NAME' : 'hysop', 'HYSOP_VERSION' : hysop_version, - 'PACKAGE_VERSION' : hysop_version, - 'CMAKE_CURRENT_SOURCE_DIR' : doc_src_dir, - 'CMAKE_CURRENT_BINARY_DIR' : doc_build_dir, - 'CMAKE_BINARY_DIR' : doc_build_dir, - 'CMAKE_SOURCE_DIR' : project_dir, + 'DOC_BUILD_DIR' : doc_build_dir, 'DOXYGEN_DOT_PATH' : doxygen_dot.full_path(), 'DOXYGEN_CONFIG' : doc_build_dir + '/config/hysop.doxyfile', 'DOXYGEN_INPUTS' : project_dir+'/hysop' + ' ' + project_dir+'/src', @@ -30,6 +26,7 @@ conf_doc_data = configuration_data({ 'BIBTEXFILE': doc_bibtexfile, 'HYSOP_COPYRIGHT': copyright.stdout().strip().replace('${years}',years.stdout().strip()), 'HYSOP_BUILD_PYTHONPATH':meson_build_dir, + 'HYSOP_SOURCE_DIR' : project_dir, }) # == pages generator == diff --git a/docs/hysop-doc b/docs/hysop-doc index 3318fc63f69a0c744ca959c0286fbf42dd73dfc3..0bb9e0c6ba19e880779736f7123869ee1efab2ea 160000 --- a/docs/hysop-doc +++ b/docs/hysop-doc @@ -1 +1 @@ -Subproject commit 3318fc63f69a0c744ca959c0286fbf42dd73dfc3 +Subproject commit 0bb9e0c6ba19e880779736f7123869ee1efab2ea diff --git a/docs/sphinx_minimal/conf.py.in b/docs/sphinx_minimal/conf.py.in index a458db0a6b56617ea5d570cc8f0439f84a9e8bcd..ebd0fc26dd44035a4bbc0713743c481d1c092b2b 100644 --- a/docs/sphinx_minimal/conf.py.in +++ b/docs/sphinx_minimal/conf.py.in @@ -69,11 +69,11 @@ napoleon_use_rtype = True # ----------------------------------------------------------------------------- import glob -# autosummary_generate = glob.glob("@CMAKE_CURRENT_BINARY_DIR@/sphinx_source/reference/*.rst") +# autosummary_generate = glob.glob("@DOC_BUILD_DIR@/sphinx_source/reference/*.rst") doxylink = { 'doxy': - ('@CMAKE_CURRENT_BINARY_DIR@/build/tags/@PROJECT_NAME@.tag', + ('@DOC_BUILD_DIR@/build/tags/@PROJECT_NAME@.tag', 'doxygen/html'), }