From b7696ff219f398975507faaf80e13dd0d7cb2650 Mon Sep 17 00:00:00 2001
From: CamStan <stanavige1@llnl.gov>
Date: Thu, 14 Sep 2023 13:06:15 -0700
Subject: [PATCH] Docs: Update to use yaml files

Read the Docs has moved to a yaml file format that is needed to
continue building our docs in the future.

- Adds yaml files for doc and doc-dev
- Fix reference link
- Remove static path from developer docs
- Update developer docs version

NOTE: fail_on_warning and builds for pull requests can be enabled in
the future if desired. This will error on doc changes that violate
rst syntax (can be finicky) and add a build status report to open
pull requests.
---
 doc-dev/.readthedocs.yaml | 27 +++++++++++++++++++++++++++
 doc-dev/rst/conf.py       |  6 +++---
 doc/.readthedocs.yaml     | 27 +++++++++++++++++++++++++++
 doc/rst/users/config.rst  |  2 +-
 4 files changed, 58 insertions(+), 4 deletions(-)
 create mode 100644 doc-dev/.readthedocs.yaml
 create mode 100644 doc/.readthedocs.yaml

diff --git a/doc-dev/.readthedocs.yaml b/doc-dev/.readthedocs.yaml
new file mode 100644
index 00000000..38ab6456
--- /dev/null
+++ b/doc-dev/.readthedocs.yaml
@@ -0,0 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+formats:
+  - pdf
+  - epub
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build developer documentation in the doc-dev/ directory with Sphinx
+sphinx:
+  configuration: doc-dev/rst/conf.py
+  #fail_on_warning: true
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+# python:
+#   install:
+#   - requirements: doc-dev/requirements.txt
diff --git a/doc-dev/rst/conf.py b/doc-dev/rst/conf.py
index f1873051..754a5b39 100644
--- a/doc-dev/rst/conf.py
+++ b/doc-dev/rst/conf.py
@@ -48,9 +48,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '1.2.0'
+version = '3.0'
 # The full version, including alpha/beta/rc tags.
-release = '1.2.0'
+release = '3.0.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -120,7 +120,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+#html_static_path = ['_static']
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
diff --git a/doc/.readthedocs.yaml b/doc/.readthedocs.yaml
new file mode 100644
index 00000000..b446d2b5
--- /dev/null
+++ b/doc/.readthedocs.yaml
@@ -0,0 +1,27 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+formats:
+  - pdf
+  - epub
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+# Build user documentation in the doc/ directory with Sphinx
+sphinx:
+  configuration: doc/rst/conf.py
+  #fail_on_warning: true
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: doc/requirements.txt
diff --git a/doc/rst/users/config.rst b/doc/rst/users/config.rst
index 29410cac..3d7003db 100644
--- a/doc/rst/users/config.rst
+++ b/doc/rst/users/config.rst
@@ -282,7 +282,7 @@ Restart with a different number of processes
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To restart an application with a different number of processes than used to save the checkpoint,
-one must follow the steps listed in :ref:`scr-integration-restart-without`.
+one must follow the steps listed in :ref:`sec-integration-restart-without`.
 Additionally, one should set the following::
 
   SCR_FLUSH_ON_RESTART=1