Merge pull request #1200 from LLNL/task/white238/fix_rtd

Install base requirements for RTD

.readthedocs.yml

@@ -10,6 +10,10 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.11"
+  apt_packages:
+    - ghostscript
+    - graphviz
+    - texlive-full
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

README.md

@@ -7,7 +7,7 @@
 [comment]: # (#################################################################)
 
 
-# <img src="/share/axom/logo/axom_logo.png?raw=true" width="250" valign="middle" alt="Axom"/>
+# <img src="/share/axom/logo/axom_logo_transparent.png?raw=true" width="250" valign="middle" alt="Axom"/>
 
 [![Azure Pipelines Build Status](https://dev.azure.com/axom/axom/_apis/build/status/LLNL.axom?branchName=develop)](https://dev.azure.com/axom/axom/_build/latest?definitionId=1&branchName=develop)
 [![Documentation Status](https://readthedocs.org/projects/axom/badge/?version=develop)](https://axom.readthedocs.io/en/develop/?badge=develop)

src/axom/sidre/docs/sphinx/query_data.rst

@@ -3,7 +3,7 @@
 .. ##
 .. ## SPDX-License-Identifier: (BSD-3-Clause)
 
-.. _dataconcepts-label:
+.. _datastore-queries-label:
 
 ===========================
 Datastore Queries

src/conf.py

@@ -54,6 +54,7 @@
     'sphinx.ext.graphviz',
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
+    'sphinxcontrib.jquery',
     'sphinx.ext.todo',
     'sphinx.ext.coverage',
     'sphinx.ext.mathjax'
@@ -244,8 +245,16 @@
 # primal, quest, sphinx:
 # override wide tables in RTD theme
 # (Thanks to https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html)
-html_context = { 'css_files': [ '_static/theme_overrides.css', ], }
+# These folders are copied to the documentation's HTML output
+html_static_path = ['docs/sphinx/_static/theme_overrides.css']
 
+# These paths are either relative to html_static_path
+# or fully qualified paths (eg. https://...)
+html_css_files = [
+    'theme_overrides.css',
+]
+
+html_logo = "../share/axom/logo/axom_logo_transparent.png"
 
 # -- Options for LaTeX output ---------------------------------------------
 

src/docs/doxygen/Doxyfile.in

@@ -231,12 +231,6 @@ TAB_SIZE               = 4
 ALIASES                = "accelerated=\xrefitem accelerated_list \"\"\"\"" \
                          "collective=\xrefitem collective_list \"\"\"\""
 
-# This tag can be used to specify a number of word-keyword mappings (TCL only).
-# A mapping has the form "name=value". For example adding "class=itcl::class"
-# will allow you to use the command class in the itcl::class meaning.
-
-TCL_SUBST              =
-
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
 # only. Doxygen will then generate output that is more tailored for C. For
 # instance, some of the names that are used will be different. The list of all
@@ -800,7 +794,6 @@ INPUT                  = @PROJECT_SOURCE_DIR@/axom/doxygen_mainpage.md \
                          @PROJECT_SOURCE_DIR@/axom/quest \
                          @PROJECT_SOURCE_DIR@/axom/quest/doxygen_mainpage.md \
                          @PROJECT_SOURCE_DIR@/axom/quest/interface \
-                         @PROJECT_SOURCE_DIR@/axom/quest/stl \
                          @PROJECT_SOURCE_DIR@/axom/sidre/doxygen_mainpage.md \
                          @PROJECT_SOURCE_DIR@/axom/sidre/core \
                          @PROJECT_SOURCE_DIR@/axom/sidre/spio \
@@ -1081,13 +1074,6 @@ VERBATIM_HEADERS       = NO
 
 ALPHABETICAL_INDEX     = YES
 
-# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
-# which the alphabetical index list will be split.
-# Minimum value: 1, maximum value: 20, default value: 5.
-# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
-
-COLS_IN_ALPHA_INDEX    = 5
-
 # In case all classes in a project start with a common prefix, all classes will
 # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
 # can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -2148,12 +2134,6 @@ EXTERNAL_GROUPS        = YES
 
 EXTERNAL_PAGES         = YES
 
-# The PERL_PATH should be the absolute path and name of the perl script
-# interpreter (i.e. the result of 'which perl').
-# The default file (with absolute path) is: /usr/bin/perl.
-
-PERL_PATH              = @SAMRAI_PERL@
-
 #---------------------------------------------------------------------------
 # Configuration options related to the dot tool
 #---------------------------------------------------------------------------
@@ -2167,15 +2147,6 @@ PERL_PATH              = @SAMRAI_PERL@
 
 CLASS_DIAGRAMS         = YES
 
-# You can define message sequence charts within doxygen comments using the \msc
-# command. Doxygen will then run the mscgen tool (see:
-# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the
-# documentation. The MSCGEN_PATH tag allows you to specify the directory where
-# the mscgen tool resides. If left empty the tool is assumed to be found in the
-# default search path.
-
-MSCGEN_PATH            =
-
 # You can include diagrams made with dia in doxygen documentation. Doxygen will
 # then run dia to produce the diagram and insert it in the documentation. The
 # DIA_PATH tag allows you to specify the directory where the dia binary resides.
@@ -2374,7 +2345,7 @@ INTERACTIVE_SVG        = YES
 # found. If left blank, it is assumed the dot tool can be found in the path.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_PATH               = @DOT_PATH@
+DOT_PATH               =
 
 # The DOTFILE_DIRS tag can be used to specify one or more directories that
 # contain dot files that are included in the documentation (see the \dotfile

src/docs/requirements.txt

@@ -1 +1,3 @@
-docutils<0.18
+docutils
+sphinx==6.2.1
+sphinx-rtd-theme==1.2.2

src/docs/sphinx/_static/theme_overrides.css

@@ -11,3 +11,12 @@
       overflow: visible !important;
    }
 }
+
+a img.logo {
+    transform: scale(.75)
+}
+
+/* Sidebar header (and topbar for mobile) */
+.wy-side-nav-search, .wy-nav-top {
+  background: #343131;
+}

src/docs/sphinx/quickstart_guide/zero_to_axom.rst

@@ -127,8 +127,8 @@ See:  ``examples/axom/using-with-blt``
 Makefile-based build system example
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-.. literalinclude:: ../../../examples/using-with-make/Makefile
+.. literalinclude:: ../../../examples/using-with-make/Makefile.in
    :language: make
-   :lines: 20-25
+   :lines: 28-39
 
 See: ``examples/axom/using-with-make``