Switcher again (#291)

* copying switcher even for branch builds * trying to correct versions * trying to fix switcher * trying to fix the switcher * switching tab system * putting back branch build
NCAR · Oct 5, 2023 · d1f27f3 · d1f27f3
1 parent d3a494e
commit d1f27f3
Show file tree

Hide file tree

Showing 11 changed files with 51 additions and 46 deletions.
diff --git a/.github/workflows/gh_pages.yml b/.github/workflows/gh_pages.yml
@@ -51,7 +51,7 @@ jobs:
           set -x
           mkdir -p _build/html/versions
 
-          # create two copies of the documentaiton
+          # create two copies of the documentation
           # 1. the frozen version, represented as vX.X in the version switcher
           docker build -t micm -f docker/Dockerfile.docs .
           id=$(docker create micm)
@@ -73,7 +73,9 @@ jobs:
           # _gh-pages itself.
           find _gh-pages/ -mindepth 1 ! -path '_gh-pages/branch*' ! -path '_gh-pages/versions*' -delete
           rsync -a _build/html/versions/stable/* _gh-pages/
-          mv docs/switcher.json _gh-pages
+          mkdir -p _gh-pages/versions
+          rsync -a _build/html/versions/* _gh-pages/versions
+          # mv docs/switcher.json _gh-pages
 
       # If a push and not on default branch, then copy the build to
       # _gh-pages/branch/$brname (transforming '/' into '--')

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -3,5 +3,4 @@ sphinx
 sphinx-book-theme
 sphinx-copybutton
 sphinx-design
-sphinx-tabs
 sphinxcontrib-bibtex
diff --git a/docs/source/_static/switcher.json b/docs/source/_static/switcher.json
@@ -0,0 +1,17 @@
+[
+  {
+      "name": "v3.2.0 (stable)",
+      "version": "v3.2.0 (stable)",
+      "url": "https://ncar.github.io/micm"
+  },
+  {
+      "name": "v3.2.0",
+      "version": "3.2.0",
+      "url": "https://ncar.github.io/micm/versions/3.2.0"
+  },
+  {
+    "name": "dev",
+    "version": "dev",
+    "url": "https://ncar.github.io/micm/branch/main/"
+  }
+]
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,9 +21,9 @@
 copyright = f'2022-{datetime.datetime.now().year}, NCAR/UCAR'
 author = 'NCAR/UCAR'
 
-# The full version, including alpha/beta/rc tags
-release = '3.2.0'
-
+suffix = os.getenv("SWITCHER_SUFFIX", "")
+# the suffix is required. This is controlled by the dockerfile that builds the docs
+release = f'v3.2.0{suffix}'
 
 # -- General configuration ---------------------------------------------------
 
@@ -34,7 +34,6 @@
   'breathe',
   'sphinx_copybutton',
   'sphinx_design',
-  'sphinx_tabs.tabs',
   'sphinxcontrib.bibtex',
 ]
 
@@ -64,7 +63,7 @@
     "github_url": "https://github.com/NCAR/micm",
     "navbar_end": ["version-switcher", "navbar-icon-links"],
     "switcher": {
-        "json_url": "https://ncar.github.io/micm/switcher.json",
+        "json_url": "https://ncar.github.io/micm/_static/switcher.json",
         "version_match": release,
     },
 }

diff --git a/docs/source/user_guide/but_how_fast_is_it.rst b/docs/source/user_guide/but_how_fast_is_it.rst
@@ -18,9 +18,9 @@ the solver.
 If you're looking for a copy and paste, choose
 the appropriate tab below and be on your way! Otherwise, stick around for a line by line explanation.
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
       .. literalinclude:: ../../../test/tutorial/test_but_how_fast_is_it.cpp
         :language: cpp

diff --git a/docs/source/user_guide/multiple_grid_cells.rst b/docs/source/user_guide/multiple_grid_cells.rst
@@ -20,9 +20,9 @@ The third grid cell will have concentrations half as large as the first grid cel
 If you're looking for a copy and paste, choose
 the appropriate tab below and be on your way! Otherwise, stick around for a line by line explanation.
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
       .. literalinclude:: ../../../test/tutorial/test_multiple_grid_cells.cpp
         :language: cpp

diff --git a/docs/source/user_guide/openmp.rst b/docs/source/user_guide/openmp.rst
@@ -14,9 +14,9 @@ We will use a simple 3-reaction 3-species mechanism. The setup here is the same
 
 If you're looking for a copy and paste, copy below and be on your way! Otherwise, stick around for a line by line explanation.
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
       .. raw:: html
 

diff --git a/docs/source/user_guide/rate_constant_tutorial.rst b/docs/source/user_guide/rate_constant_tutorial.rst
@@ -41,14 +41,14 @@ If you're looking for a copy and paste, choose
 the appropriate tab below and be on your way! Otherwise, stick around for a line by line explanation.
 
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
         .. literalinclude:: ../../../test/tutorial/test_rate_constants_no_user_defined_by_hand.cpp
           :language: cpp
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
         .. raw:: html
 
@@ -81,9 +81,9 @@ rosenbrock solver.
 To create a :cpp:class:`micm::RosenbrockSolver`, we have to define a chemical system (:cpp:class:`micm::System`)
 and our reactions, which will be a vector of :cpp:class:`micm::Process` We will use the species to define these.
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
         To do this by hand, we have to define all of the chemical species in the system. This allows us to set
         any properties of the species that may be necessary for rate constanta calculations, like molecular weights 
@@ -108,7 +108,7 @@ and our reactions, which will be a vector of :cpp:class:`micm::Process` We will
           :language: cpp
           :lines: 135-136
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
         After defining a valid OpenAtmos configuration with reactions that ``micm`` supports, configuring the chemical
         system and the processes is as simple as using the :cpp:class:`micm::SolverConfig` class
@@ -133,15 +133,15 @@ custom rate parameters, and temperature and pressure
 Initializing the state
 ^^^^^^^^^^^^^^^^^^^^^^
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
         .. literalinclude:: ../../../test/tutorial/test_rate_constants_no_user_defined_by_hand.cpp
           :language: cpp
           :lines: 141-155
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
         .. literalinclude:: ../../../test/tutorial/test_rate_constants_no_user_defined_with_config.cpp
           :language: cpp

diff --git a/docs/source/user_guide/solver_configurations.rst b/docs/source/user_guide/solver_configurations.rst
@@ -16,9 +16,9 @@ We will use a simple 3-reaction 3-species mechanism. The setup here is the same
 If you're looking for a copy and paste, choose
 the appropriate tab below and be on your way! Otherwise, stick around for a line by line explanation.
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
       .. literalinclude:: ../../../test/tutorial/test_solver_configuration.cpp
         :language: cpp

diff --git a/docs/source/user_guide/user_defined_rate_constant_tutorial.rst b/docs/source/user_guide/user_defined_rate_constant_tutorial.rst
@@ -29,14 +29,14 @@ To show how this works, we'll add one photolysis reaction, one first-order loss
 If you're looking for a copy and paste, choose
 the appropriate tab below and be on your way! Otherwise, stick around for a line by line explanation.
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
         .. literalinclude:: ../../../test/tutorial/test_rate_constants_user_defined_by_hand.cpp
           :language: cpp
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
         .. raw:: html
 
@@ -70,9 +70,9 @@ Then setup the reaction which will use this rate constant:
 
 
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
         .. code-block:: diff
 
@@ -104,7 +104,7 @@ Then setup the reaction which will use this rate constant:
 
 
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
         In this case, you only need to add the configuration to the reactions.json file in the configuration directory.
 
@@ -137,9 +137,9 @@ Finally, set and upate the rate constants as needed:
 
 
 
-.. tabs::
+.. tab-set::
 
-    .. tab:: Build the Mechanism with the API
+    .. tab-item:: Build the Mechanism with the API
 
         .. code-block:: diff
 
@@ -171,7 +171,7 @@ Finally, set and upate the rate constants as needed:
           +   photo_rate *= 1.5;
            }
 
-    .. tab:: OpenAtmos Configuration reading
+    .. tab-item:: OpenAtmos Configuration reading
 
         In this case, you only need to add the configuration to the reactions.json file in the configuration directory.
         When reading in from a configuration file, the loss, emissions, and photolysis rates are prefixed with

diff --git a/docs/switcher.json b/docs/switcher.json