mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
Merge topic 'user-guide-todos'
39aa256bb docs: edit .readthedocs.yaml b261d2387 Allow turning off todo notes in user's guide Acked-by: Kitware Robot <kwrobot@kitware.com> Acked-by: Kenneth Moreland <morelandkd@ornl.gov> Acked-by: Vicente Bolea <vicente.bolea@kitware.com> Merge-request: !3145
This commit is contained in:
commit
8297109a01
@ -66,6 +66,7 @@ foreach(option IN LISTS options)
|
|||||||
|
|
||||||
elseif(docs STREQUAL option)
|
elseif(docs STREQUAL option)
|
||||||
set(VTKm_ENABLE_DOCUMENTATION "ON" CACHE STRING "")
|
set(VTKm_ENABLE_DOCUMENTATION "ON" CACHE STRING "")
|
||||||
|
set(VTKm_USERS_GUIDE_INCLUDE_TODOS "OFF" CACHE STRING "")
|
||||||
|
|
||||||
elseif(benchmarks STREQUAL option)
|
elseif(benchmarks STREQUAL option)
|
||||||
set(VTKm_ENABLE_BENCHMARKS "ON" CACHE STRING "")
|
set(VTKm_ENABLE_BENCHMARKS "ON" CACHE STRING "")
|
||||||
|
@ -27,7 +27,7 @@ build:
|
|||||||
- git lfs install --local
|
- git lfs install --local
|
||||||
- git lfs fetch --include "*.png"
|
- git lfs fetch --include "*.png"
|
||||||
- git lfs checkout *.png
|
- git lfs checkout *.png
|
||||||
- cmake -B build -S . -DVTKm_ENABLE_DOCUMENTATION=ON -DVTKm_ENABLE_USERS_GUIDE=ON
|
- cmake -B build -S . -DVTKm_ENABLE_DOCUMENTATION=ON -DVTKm_ENABLE_USERS_GUIDE=ON -DVTKm_USERS_GUIDE_INCLUDE_TODOS=OFF
|
||||||
- cmake --build build --target VTKmDoxygenDocs
|
- cmake --build build --target VTKmDoxygenDocs
|
||||||
- cp -f ./build/docs/users-guide/VTKmUsersGuideHTML.cache/conf.py docs/users-guide/conf.py
|
- cp -f ./build/docs/users-guide/VTKmUsersGuideHTML.cache/conf.py docs/users-guide/conf.py
|
||||||
|
|
||||||
|
@ -25,9 +25,18 @@ if (NOT Sphinx_FOUND)
|
|||||||
"Could not find Sphinx to build User's Guide. If you want to compile Doxygen without the User's Guide, turn off VTKm_ENABLE_USERS_GUIDE.")
|
"Could not find Sphinx to build User's Guide. If you want to compile Doxygen without the User's Guide, turn off VTKm_ENABLE_USERS_GUIDE.")
|
||||||
endif()
|
endif()
|
||||||
|
|
||||||
|
option(VTKm_USERS_GUIDE_INCLUDE_TODOS
|
||||||
|
"When building the VTK-m User's Guide, specify whether to include TODO notes." ON)
|
||||||
|
mark_as_advanced(VTKm_USERS_GUIDE_INCLUDE_TODOS)
|
||||||
|
|
||||||
# Configuration used in conf.py.
|
# Configuration used in conf.py.
|
||||||
set(doxygen_xml_output_dir "${VTKm_BINARY_DIR}/docs/doxygen/xml")
|
set(doxygen_xml_output_dir "${VTKm_BINARY_DIR}/docs/doxygen/xml")
|
||||||
set(example_directory "${CMAKE_CURRENT_SOURCE_DIR}/examples")
|
set(example_directory "${CMAKE_CURRENT_SOURCE_DIR}/examples")
|
||||||
|
if(VTKm_USERS_GUIDE_INCLUDE_TODOS)
|
||||||
|
set(include_todos "True")
|
||||||
|
else()
|
||||||
|
set(include_todos "False")
|
||||||
|
endif()
|
||||||
|
|
||||||
sphinx_add_docs(VTKmUsersGuideHTML
|
sphinx_add_docs(VTKmUsersGuideHTML
|
||||||
BUILDER html
|
BUILDER html
|
||||||
|
@ -52,7 +52,7 @@ extensions = [
|
|||||||
]
|
]
|
||||||
# Note: there are some custom extensions at the bottom of this file.
|
# Note: there are some custom extensions at the bottom of this file.
|
||||||
|
|
||||||
todo_include_todos = True
|
todo_include_todos = @include_todos@
|
||||||
|
|
||||||
numfig = True
|
numfig = True
|
||||||
autosectionlabel_prefix_document = True
|
autosectionlabel_prefix_document = True
|
||||||
|
@ -4,8 +4,6 @@
|
|||||||
The VTK-m User's Guide
|
The VTK-m User's Guide
|
||||||
==============================
|
==============================
|
||||||
|
|
||||||
.. todo:: Hide TODOs for release documentation.
|
|
||||||
|
|
||||||
| **The VTK-m User's Guide**
|
| **The VTK-m User's Guide**
|
||||||
| Version |version|
|
| Version |version|
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user