Update NTD2D PDF generator

usnistgov · Sep 18, 2023 · 8fd6a81 · 8fd6a81
1 parent 64d5162
commit 8fd6a81
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 7 deletions.
diff --git a/.github/workflows/nist-docs.yml b/.github/workflows/nist-docs.yml
@@ -11,6 +11,7 @@ jobs:
         with:
           apt-packages: |-
              doxygen
+          build-pdf-command: make pdf
           docs-folder: doc/
           formats: |-
             pdf

diff --git a/doc/Doxyfile b/doc/Doxyfile
@@ -3,14 +3,18 @@
 PROJECT_NAME          = HiPerC
 PROJECT_BRIEF         = High Performance Computing Strategies for Boundary Value Problems
 OUTPUT_DIRECTORY      = .
-PROJECT_NUMBER        = pre-alpha
+PROJECT_NUMBER        = alpha
 FULL_PATH_NAMES       = NO
 HIDE_UNDOC_MEMBERS    = YES
 HIDE_UNDOC_CLASSES    = NO
 SOURCE_BROWSER        = YES
-INPUT                 = ../common-diffusion/ \
-                        ../cpu-serial-diffusion/ ../cpu-openmp-diffusion/ ../cpu-tbb-diffusion/ \
-                        ../gpu-cuda-diffusion/ ../gpu-openacc-diffusion/ ../gpu-opencl-diffusion/
+INPUT                 = ../common-diffusion/      \
+                        ../cpu-serial-diffusion/  \
+                        ../cpu-openmp-diffusion/  \
+                        ../cpu-tbb-diffusion/     \
+                        ../gpu-cuda-diffusion/    \
+                        ../gpu-openacc-diffusion/ \
+                        ../gpu-opencl-diffusion/
 RECURSIVE             = YES
 FILE_PATTERNS         = *.c *.cl *.cpp *.cu *.cuh *.h
 EXCLUDE_PATTERNS      = *.git doc

diff --git a/doc/conf.py b/doc/conf.py
@@ -21,7 +21,6 @@
 import shutil
 import subprocess
 import sys
-import recommonmark
 from recommonmark.parser import CommonMarkParser
 from recommonmark.transform import AutoStructify
 
@@ -35,12 +34,17 @@
 
 # If your documentation needs a minimal Sphinx version, state it here.
 #
-needs_sphinx = "1.8"
+needs_sphinx = "2.3"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.graphviz", "sphinx.ext.mathjax", "sphinx.ext.todo", "breathe"]
+extensions = [
+    "sphinx.ext.graphviz",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.todo",
+    "breathe"
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]