From d06585c2270c54fafa0b6daa85d10da010ddda7b Mon Sep 17 00:00:00 2001 From: andrew-platt Date: Tue, 7 Feb 2023 18:25:38 -0700 Subject: [PATCH 1/2] [BugFix] rtd configuration changes broke our build MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I have a suspicion that the argument parsing in python or some package in it changed (I can reproduce the issue locally). There is an arguement in `CMakeListst.txt` for the `sphinx-html` command that indicates where the `conf.py` is located (`-c ${CMAKE_CURRENT_BINARY_DIR}`). This is at the end of the command for `sphinx-html`. The argument parsing in `conf.py` is assuming this last argument doesn't count as it finds the arguments for the path to `doxygen` and `openfast.tag`. Something somewhere appears to have changed this behavior. Removing this last argument restores the ability for me to build locally and for rtd to build and really has no impact as conf.py gets copied to the build dir. Still have no clue what changed at rtd to cause this -- maybe a newer python? --- docs/CMakeLists.txt | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 7e67f2f05f..176286d015 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -29,15 +29,13 @@ else() # Add a sphinx-only HTML target to avoid building doxygen while developing documentation add_custom_target(sphinx-html COMMAND ${SPHINX_EXECUTABLE} -M html - "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}" - -c ${CMAKE_CURRENT_SOURCE_DIR}) + "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}") # PDF documentation generation using sphinx -> latex -> pdflatex find_package(LATEX COMPONENTS PDFLATEX BIBTEX) if (LATEX_FOUND) add_custom_target(sphinx-pdf COMMAND ${SPHINX_EXECUTABLE} -M latexpdf - "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}" - -c ${CMAKE_CURRENT_BINARY_DIR}) + "${CMAKE_CURRENT_SOURCE_DIR}" "${CMAKE_CURRENT_BINARY_DIR}") endif() endif() From ab44c8bd2a73a793606ef66d306bcdac90275f51 Mon Sep 17 00:00:00 2001 From: andrew-platt Date: Wed, 8 Feb 2023 20:43:04 -0700 Subject: [PATCH 2/2] Disable doxygen on readthedocs --- .readthedocs.yml | 2 +- docs/conf.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.readthedocs.yml b/.readthedocs.yml index 2a5338b5c2..5b54f8b4a3 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -7,7 +7,7 @@ version: 2 formats: - htmlzip - - pdf + # - pdf # - epub python: diff --git a/docs/conf.py b/docs/conf.py index eeeee30619..fac8db0b73 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,7 +28,7 @@ sourcedir = sys.argv[-2] # Use this to turn Doxygen on or off -useDoxygen = True +useDoxygen = False # This function was adapted from https://gitlab.kitware.com/cmb/smtk # Only run when on readthedocs