Merge pull request #3108 from agriyakhetarpal/version-banner-switcher

Configure `versions.json` and remove the version switcher dropdown

.gitignore

@@ -134,5 +134,9 @@ results/
 !docs/source/examples/notebooks/models/spm1.png
 !docs/source/examples/notebooks/models/spm2.png
 
+# do not ignore images in _static folder in docs
+!docs/_static/favicon/favicon.png
+!docs/_static/pybamm_logo.png
+
 # tests
 test_callback.log

docs/source/_static/pybamm.css → docs/_static/pybamm.css

@@ -36,40 +36,6 @@ h3 {
   letter-spacing: -0.03em;
 }
 
-/* Style the active version button.
-
-- latest: orange
-- stable: green
-- old, PR: red
-
-Colors from:
-
-Wong, B. Points of view: Color blindness.
-Nat Methods 8, 441 (2011). https://doi.org/10.1038/nmeth.1618
-*/
-
-/* If the active version has the name "latest", style it orange */
-.version-switcher__button[data-active-version-name*="latest"] {
-  background-color: #e69f00;
-  border-color: #e69f00;
-  color: #000000;
-}
-
-/* green for `stable` */
-.version-switcher__button[data-active-version-name*="stable"] {
-  background-color: #009e73;
-  border-color: #009e73;
-}
-
-/* red for `old` */
-.version-switcher__button:not(
-    [data-active-version-name*="latest"],
-    [data-active-version-name*="stable"]
-  ) {
-  background-color: #980f0f;
-  border-color: #980f0f;
-}
-
 /* Main page overview cards */
 
 .sd-card {

docs/conf.py

@@ -109,15 +109,15 @@
 
 html_theme = "pydata_sphinx_theme"
 
-html_static_path = ["source/_static"]
+html_static_path = ["_static"]
 
 # Theme
 
 # pydata theme options (see
 # https://pydata-sphinx-theme.readthedocs.io/en/latest/index.html# for more information)
 # mostly copied from numpy, scipy, pandas
-html_logo = "source/_static/pybamm_logo.png"
-html_favicon = "source/_static/favicon/favicon.png"
+html_logo = "_static/pybamm_logo.png"
+html_favicon = "_static/favicon/favicon.png"
 
 html_theme_options = {
     "logo": {
@@ -148,14 +148,16 @@
             "url": "https://github.com/pybamm-team/PyBaMM/tree/develop/CONTRIBUTING.md",
         },
     ],
+    # should be kept versioned to use for the version warning bar
     "switcher": {
-        "version_match": release,
-        "json_url": "https://pybamm.readthedocs.io/en/latest/_static/versions.json",  # noqa: E501
+        "version_match": version,
+        "json_url": "https://docs.pybamm.org/en/latest/_static/versions.json",
     },
     # turn to False to not fail build if json_url is not found
     "check_switcher": True,
-    # for dark mode toggle, version switcher, and social media links
-    "navbar_end": ["theme-switcher", "version-switcher", "navbar-icon-links"],
+    # for dark mode toggle and social media links
+    # Note: the version switcher was removed in favour of the readthedocs one
+    "navbar_end": ["theme-switcher", "navbar-icon-links"],
     # add Algolia to the persistent navbar, this removes the default search icon
     "navbar_persistent": "algolia-searchbox",
     "use_edit_page_button": True,

docs/index.rst

@@ -41,7 +41,7 @@ explore the effect of different battery designs and modeling assumptions under a
 .. grid:: 2
 
    .. grid-item-card::
-      :img-top: source/_static/index-images/getting_started.svg
+      :img-top: _static/index-images/getting_started.svg
 
       User Guide
       ^^^^^^^^^^
@@ -59,7 +59,7 @@ explore the effect of different battery designs and modeling assumptions under a
          To the user guide
 
    .. grid-item-card::
-      :img-top: source/_static/index-images/examples.svg
+      :img-top: _static/index-images/examples.svg
 
       Examples
       ^^^^^^^^
@@ -77,7 +77,7 @@ explore the effect of different battery designs and modeling assumptions under a
          To the examples
 
    .. grid-item-card::
-      :img-top: source/_static/index-images/api.svg
+      :img-top: _static/index-images/api.svg
 
       API Documentation
       ^^^^^^^^^^^^^^^^^
@@ -96,7 +96,7 @@ explore the effect of different battery designs and modeling assumptions under a
          To the API documentation
 
    .. grid-item-card::
-      :img-top: source/_static/index-images/contributor.svg
+      :img-top: _static/index-images/contributor.svg
 
       Contributor's Guide
       ^^^^^^^^^^^^^^^^^^^