Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BugFix] Doxygen builds failing on rtd, and locally #1442

Merged
merged 2 commits into from
Feb 10, 2023
Merged

[BugFix] Doxygen builds failing on rtd, and locally #1442

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d06585c
[BugFix] rtd configuration changes broke our build
andrew-platt Feb 8, 2023
ab44c8b
Disable doxygen on readthedocs
andrew-platt Feb 9, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ version: 2

formats:
- htmlzip
- pdf
# - pdf
# - epub

python:
Expand Down
6 changes: 2 additions & 4 deletions docs/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down