Update sphinx theme (networkx#6930)

* Update sphinx theme

* Get rid of custom dev banner

* Remove duplicate search box

* Use theme's version switcher

* Fix docstrings

* Fix theme

* Remove old file

* Update release process

Author: jarrodmillman

doc/_static/custom.css

@@ -1,35 +1,3 @@
-.version-stable {
-    background-color: #2c7fb8ff;
-    color: #2c7fb8ff;
-}
-
-.version-alert a {
-    text-decoration: underline;
-    background-color: #2c7fb8ff;
-    color: #ddd;
-}
-
-.version-alert {
-    background-color: #ff7f0eff;
-    cff7f0effolor: #fff;
-    font-family: "Work Sans", sans-serif;
-    font-weight: 600; font-size: 16px;
-}
-
-.btn-version {
-    background: #2c7fb8ff;
-    color: #ffffff;
-}
-
-.btn-version:hover, .btn-version:focus, .btn-version:active, .btn-version.active, .open > .dropdown-toggle.btn-version {
-    background: #33a6cc;
-}
-
-.btn-version:active, .btn-version.active {
-    background: #007299;
-    box-shadow: none;
-}
-
 .team-member {
     display: inline-block;
     padding: 1rem;

doc/_templates/dev_banner.html

@@ -140,9 +140,16 @@
         },
     ],
     "external_links": [{"name": "Guides", "url": "https://networkx.org/nx-guides/"}],
-    "navbar_end": ["theme-switcher", "navbar-icon-links", "version"],
-    "secondary_sidebar_items": ["search-field", "page-toc", "edit-this-page"],
+    "navbar_end": ["theme-switcher", "navbar-icon-links", "version-switcher"],
+    "secondary_sidebar_items": ["page-toc", "edit-this-page"],
     "header_links_before_dropdown": 7,
+    "switcher": {
+        "json_url": (
+            "https://networkx.org/documentation/latest/_static/version_switcher.json"
+        ),
+        "version_match": "latest" if "dev" in version else version,
+    },
+    "show_version_warning_banner": True,
 }
 html_sidebars = {
     "**": ["sidebar-nav-bs", "sidebar-ethical-ads"],
@@ -189,14 +196,6 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "NetworkX"
 
-html_context = {
-    "versions_dropdown": {
-        "latest": "devel (latest)",
-        "stable": "current (stable)",
-    },
-    "default_mode": "light",
-}
-
 # Options for LaTeX output
 # ------------------------
 

doc/_templates/eol_banner.html

@@ -22,9 +22,8 @@ Release Process
 
   7. Add ``release_<major>.<minor>`` to ``doc/release/index.rst``.
 
-- Delete developer banner on docs::
-
-   git rm doc/_templates/layout.html
+- Edit ``doc/_static/version_switcher.json`` in order to add the release, move the
+  key value pair `"preferred": true` to the most recent stable version, and commit.
 
 - Update ``__version__`` in ``networkx/__init__.py``.
 
@@ -87,14 +86,9 @@ Release Process
 
 - Update ``__version__`` in ``networkx/__init__.py``.
 
-- Create ``doc/_templates/layout.html`` with::
-
-    {% extends "!layout.html" %} {% block content %} {% include "dev_banner.html" %}
-    {{ super() }} {% endblock %}
-
  - Commit and push changes::
 
-    git add networkx/__init__.py doc/_templates/layout.html
+    git add networkx/__init__.py 
     git commit -m "Bump release version"
     git push origin main
 

doc/_templates/layout.html

@@ -688,7 +688,7 @@ def resistance_distance(G, nodeA=None, nodeB=None, weight=None, invert_weight=Tr
        dictionary of nodes with resistance distances as the value.
 
     Raises
-    -------
+    ------
     NetworkXNotImplemented
         If `G` is a directed graph.
 

doc/_templates/version.html

@@ -135,8 +135,8 @@ def disjoint_union_all(graphs):
     NetworkXError
         In case of mixed type graphs, like MultiGraph and Graph, or directed and undirected graphs.
 
-    Example
-    -------
+    Examples
+    --------
     >>> G1 = nx.Graph([(1, 2), (2, 3)])
     >>> G2 = nx.Graph([(4, 5), (5, 6)])
     >>> U = nx.disjoint_union_all([G1, G2])
@@ -189,8 +189,8 @@ def compose_all(graphs):
     NetworkXError
         In case of mixed type graphs, like MultiGraph and Graph, or directed and undirected graphs.
 
-    Example
-    -------
+    Examples
+    --------
     >>> G1 = nx.Graph([(1, 2), (2, 3)])
     >>> G2 = nx.Graph([(3, 4), (5, 6)])
     >>> C = nx.compose_all([G1, G2])
@@ -276,8 +276,8 @@ def intersection_all(graphs):
     >>> gh.nodes(data=True)
     NodeDataView({0: {'new_capacity': 2}, 1: {'new_capacity': 3}})
 
-    Example
-    -------
+    Examples
+    --------
     >>> G1 = nx.Graph([(1, 2), (2, 3)])
     >>> G2 = nx.Graph([(2, 3), (3, 4)])
     >>> R = nx.intersection_all([G1, G2])

doc/conf.py

@@ -15,12 +15,12 @@ def s_metric(G, **kwargs):
     G : graph
         The graph used to compute the s-metric.
     normalized : bool (optional)
+        Normalize the value.
 
         .. deprecated:: 3.2
 
            The `normalized` keyword argument is deprecated and will be removed
            in the future
-        Normalize the value.
 
     Returns
     -------