update navbar (#344)

* update navbar

* Merge conflict.

Co-authored-by: Thomas Wiecki <[email protected]>

Author: OriolAbril

_static/custom.css

@@ -11,3 +11,11 @@
 .bd-sidebar {
   overflow-y: auto;
 }
+
+.navbar-brand {
+  display: inline-block !important;
+}
+
+.supportbutton a {
+ color: var(--pst-color-sidebar-link-active);
+}

_templates/donate.html

@@ -0,0 +1,9 @@
+{% if "generated" in sourcename %}
+<div class="tocsection editthispage">
+{% else %}
+<div class="tocsection supportbutton">
+{% endif %}
+    <a href="https://numfocus.org/donate-to-pymc3">
+      <i class="far fa-heart"></i> {{ _("Support PyMC") }}
+    </a>
+</div>

_templates/search-field.html

@@ -0,0 +1,4 @@
+<form class="bd-search d-flex align-items-center" action="https://www.pymc.io/search.html" method="get">
+  <i class="icon fas fa-search"></i>
+  <input type="search" class="form-control" name="q" id="search-input" placeholder="{{ _(theme_search_bar_text) }}" aria-label="{{ theme_search_bar_text }}" autocomplete="off" >
+</form>

examples/blog.md

@@ -1,3 +1,7 @@
+---
+orphan: true
+---
+
 # Recent updates
 
 <!-- auto generated by ablog so it's empty -->

examples/conf.py

@@ -1,4 +1,5 @@
 import os, sys
+from pathlib import Path
 from sphinx.application import Sphinx
 
 # -- Project information -----------------------------------------------------
@@ -26,6 +27,8 @@
     "notfound.extension",
     "sphinx_gallery.load_style",
     "thumbnail_extractor",
+    "sphinxext.rediraffe",
+    "sphinx_remove_toctrees",
 ]
 
 # List of patterns, relative to source directory, that match files and
@@ -85,8 +88,22 @@ def do_nothing(*node):
     toctree.TocTree.resolve = patched_toctree_resolve
 
 
+def remove_index(app):
+    """
+    This removes the index pages so rediraffe generates the redirect placeholder
+    It needs to be present initially for the toctree as it defines the navbar.
+    """
+
+    index_file = Path(app.outdir) / "index.html"
+    index_file.unlink()
+
+    app.env.project.docnames -= {"index"}
+    yield "", {}, "layout.html"
+
+
 def setup(app: Sphinx):
     hack_nbsphinx(app)
+    app.connect("html-collect-pages", remove_index, 100)
 
 
 # -- Options for HTML output -------------------------------------------------
@@ -108,6 +125,11 @@ def setup(app: Sphinx):
             "url": "https://twitter.com/pymc_devs",
             "icon": "fab fa-twitter-square",
         },
+        {
+            "name": "YouTube",
+            "url": "https://www.youtube.com/c/PyMCDevelopers",
+            "icon": "fab fa-youtube",
+        },
         {
             "name": "Discourse",
             "url": "https://discourse.pymc.io",
@@ -116,13 +138,9 @@ def setup(app: Sphinx):
     ],
     "search_bar_text": "Search...",
     "navbar_end": ["search-field.html", "navbar-icon-links.html"],
-    "external_links": [
-        {"name": "Contributing", "url": "https://docs.pymc.io/en/latest/contributing/index.html"},
-        {"name": "docs.pymc.io", "url": "https://docs.pymc.io"},
-        {"name": "pymc.io", "url": "https://www.pymc.io"},
-    ],
-    "page_sidebar_items": ["postcard", "page-toc", "edit-this-page"],
+    "page_sidebar_items": ["postcard", "page-toc", "edit-this-page", "donate"],
     "google_analytics_id": "G-6KPRBTE6WV",
+    "logo_link": "https://www.pymc.io",
 }
 version = os.environ.get("READTHEDOCS_VERSION", "")
 version = version if "." in version else "main"
@@ -141,6 +159,7 @@ def setup(app: Sphinx):
 
 html_favicon = "../_static/PyMC.ico"
 html_logo = "../_static/PyMC.png"
+html_title = "PyMC example gallery"
 
 # 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,
@@ -151,7 +170,7 @@ def setup(app: Sphinx):
 templates_path = ["../_templates"]
 html_sidebars = {
     "**": [
-        # "sidebar-nav-bs.html",
+        "sidebar-nav-bs.html",
         "postcard_categories.html",
         "tagcloud.html",
     ],
@@ -193,6 +212,25 @@ def setup(app: Sphinx):
 }
 jupyter_execute_notebooks = "off"
 
+rediraffe_redirects = {
+    "index.md": "gallery.md",
+}
+remove_from_toctrees = [
+    "BART/*",
+    "case_studies/*",
+    "diagnostics_and_criticism/*",
+    "gaussian_processes/*",
+    "generalized_linear_models/*",
+    "mixture_models/*",
+    "ode_models/*",
+    "pymc3_howto/*",
+    "samplers/*",
+    "splines/*",
+    "survival_analysis/*",
+    "time_series/*",
+    "variational_inference/*",
+]
+
 # bibtex config
 bibtex_bibfiles = ["references.bib"]
 bibtex_default_style = "unsrt"

examples/gallery.rst

@@ -1,12 +1,15 @@
-Gallery
-=======
+PyMC Example Gallery
+====================
 
+.. toctree::
+   :hidden:
+
+   object_index/index
 
 (Generalized) Linear and Hierarchical Linear Models
 -------------------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: generalized_linear_models
     :glob:
     :reversed:
@@ -18,7 +21,6 @@ Case Studies
 ------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: case_studies
     :glob:
     :reversed:
@@ -29,7 +31,6 @@ Diagnostics and Model Criticism
 -------------------------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: diagnostics_and_criticism
     :glob:
     :reversed:
@@ -41,7 +42,6 @@ Gaussian Processes
 ------------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: gaussian_processes
     :glob:
     :reversed:
@@ -52,7 +52,6 @@ Inference in ODE models
 -----------------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: ode_models
     :glob:
     :reversed:
@@ -63,7 +62,6 @@ MCMC
 ----
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: samplers
     :glob:
     :reversed:
@@ -74,7 +72,6 @@ Mixture Models
 --------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: mixture_models
     :glob:
     :reversed:
@@ -85,7 +82,6 @@ Survival Analysis
 -----------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: survival_analysis
     :glob:
     :reversed:
@@ -96,7 +92,6 @@ Time Series
 -----------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: time_series
     :glob:
     :reversed:
@@ -107,7 +102,6 @@ Variational Inference
 ---------------------
 
 .. nbgallery::
-    :caption: This is a thumbnail gallery:
     :name: variational_inference
     :glob:
     :reversed:

examples/index.md

@@ -1,80 +1,12 @@
 # PyMC example gallery
 
-**Welcome to the PyMC example gallery!**
-
-The PyMC example gallery is a collection of Jupyter notebooks
-about PyMC and its usage. These notebooks can be tutorials,
-case studies or in-depth explanations.
-Some notebooks were originally blog posts, others were adapted from books
-and some were written specifically for this example gallery.
-This homepage explains the organization of the website and provides
-some pointers on how to navigate it.
-
-The collection contains more than 90 notebooks. We are therefore unable
-to ensure notebooks are updated and re-executed at the same pace we
-publish PyMC releases. Consequently, PyMC has two documentation
-websites: the versioned docs and the example gallery
-
-## Versioned docs
-We publish the versioned docs directly at `docs.pymc.io`. The only additions
-to the url are the language and version of the documentation.
-
-The versioned docs are synced with PyMC releases and contain a handful of
-guides about core functionality and the API documentation among other things.
-
-## Example gallery
-We publish the example gallery as a sub-project of the versioned docs: `docs.pymc.io/projects/examples`
-This means that the building process, language and version of the
-example gallery are independent from the versioned docs. However,
-the {ref}`search bar in the versioned docs <pymc:search>` searches
-both the versioned docs and the example gallery at the same time
-(but not the other way around).
-
-We will update the notebooks in the example gallery regularly
-and publish the updates to the example gallery website with each commit.
-We recommend using the example gallery as an unversioned living
-resource, but we will also provide snapshots every few months for cases such as books
-that need links to a stable resource.
-
-You can access the snapshots from the version menu at the bottom right of the page.
-A version number in the `YYYY.0M.MICRO` format identifies the time the snapshot was published.
-
----
-
-Notebooks are treated as blog posts. The metadata of each notebook
-describes its topics and type of content via tags and categories
-and the last update date. We believe that tags and categories
-ease and improve navigation (as opposed to a fixed topic division/hierarchy).
-In addition, we also provide a list of recent updates and a search bar in the
-navigation bar at the top of the page.
-
-:::{caution}
-The website is still under construction. Thus, not all notebooks have been updated
-to include all the relevant metadata. Those notebooks can only be reached
-from the search bar.
-:::
-
-### Categories
-Notebooks have at most two categories, one indicating the level of the
-notebook and another indicating the type of content according to the
-[diataxis framework](https://diataxis.fr/). The left sidebar
-shows all 7 categories (3 levels + 4 types) at all times. You can click
-there to reach the page listing all the notebooks in that category.
-If a page has some categories in its metadata they are highlighted in green
-in the category list.
-
-### Tags
-Notebooks can have any number of tags. Each tag represents a specific topic
-of potential interest to readers or a pymc object used within that notebook.
-
-The left sidebar shows all tags at all times. Like categories, they can be clicked
-on to reach the page listing all notebooks that contain the tag. If a notebook
-has tags in its metadata they are listed on the right sidebar after the {fas}`tags` icon.
-
 :::{toctree}
-:maxdepth: 1
 :hidden:
-gallery
-blog
-object_index/index
+
+Home <https://www.pymc.io>
+Examples <gallery>
+User guide <https://www.pymc.io/projects/docs/en/latest/learning.html>
+API <https://www.pymc.io/projects/docs/en/latest/api.html>
+Community <https://www.pymc.io/community/index.html>
+Contributing <https://www.pymc.io/projects/docs/en/latest/contributing/index.html>
 :::

requirements-docs.txt

@@ -11,3 +11,5 @@ sphinx-notfound-page
 nbsphinx
 sphinx-gallery
 matplotlib
+sphinxext-rediraffe
+sphinx-remove-toctrees