Theme update

.github/workflows/ci.yaml

@@ -7,63 +7,48 @@ on:
     tags:
       - '*'
   pull_request:
+  workflow_dispatch:
 
 jobs:
-
   jupyterbook:
-    name: Build Jupyter Book
+    name: Build Jupyter Book and Sphinx Docs
     runs-on: ubuntu-latest
+
     steps:
     - uses: actions/checkout@v2
+
+    - name: Cancel previous runs
+      uses: styfle/[email protected]
+      with:
+        access_token: ${{ github.token }}
+
+    - name: checkout
+      uses: actions/checkout@v4
+      with:
+        token: ${{ github.token }}
+
     - name: Set up Python
       uses: actions/setup-python@v2
       with:
-        python-version: 3.8
+        python-version: 3.11
+
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
         pip install -r requirements.txt
-        pip install -e .
+        python -m pip install . --no-deps
+
+    - name: pip list
+      run: |
+        pip list
+
     - name: Download references from Sphinx Book Theme
-      run: python docs/getreferences.py docs/references
-    - name: Build Jupyter Book
-      run: jupyter-book build docs
+      run: |
+        python docs/getreferences.py docs/references
 
-  sphinx:
-    name: Build Sphinx Docs
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python
-      uses: actions/setup-python@v2
-      with:
-        python-version: 3.8
-    - name: Install dependencies
+    - name: Build Jupyter Book
       run: |
-        python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install -e .
+        jupyter-book build docs
+
     - name: Build Sphinx documentation
       run: sphinx-build -b html docs docs/_build/html
-
-  publish:
-    name: Publish to PyPI
-    needs: [jupyterbook, sphinx]
-    if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout source
-        uses: actions/checkout@v2
-      - name: Set up Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: 3.8
-      - name: Install build dependecies
-        run: pip install setuptools setuptools-scm wheel
-      - name: Build package
-        run: python setup.py sdist bdist_wheel
-      - name: Publish
-        uses: pypa/gh-action-pypi-publish@release/v1
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/pypi.yaml

@@ -0,0 +1,67 @@
+name: Upload to PyPI
+
+on:
+  release:
+    types:
+      - published
+
+jobs:
+  test-build:
+    if: github.repository == 'ProjectPythia/sphinx-pythia-theme'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install build twine
+
+      - name: Build tarball and wheels
+        run: |
+          git clean -xdf
+          git restore -SW .
+          python -m build
+
+      - name: Test the built artifacts
+        run: |
+          python -m twine check --strict dist/*
+          pwd
+          if [ -f dist/sphinx-pythia-theme-0.0.0.tar.gz ]; then
+            echo "❌ INVALID VERSION NUMBER"
+            exit 1
+          else
+            echo "✅ Looks good"
+          fi
+      - uses: actions/upload-artifact@v4
+        with:
+          name: releases
+          path: dist
+
+  publish:
+    needs: test-build
+    if: github.event_name == 'release'
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sphinx-pythia-theme
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: releases
+          path: dist
+
+      - name: Publish package to PyPI
+        uses: pypa/[email protected]
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_TOKEN }}

.readthedocs.yaml

@@ -5,14 +5,17 @@
 # Required
 version: 2
 
+build:
+  os: "ubuntu-20.04"
+  tools:
+    python: "mambaforge-4.10"
+  jobs:
+    post_create_environment:
+      - python -m pip install --no-cache-dir .
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: docs/conf.py
 
-# Optionally set the version of Python and requirements required to build your docs
-python:
-   version: '3.8'
-   install:
-   - requirements: requirements.txt
-   - method: pip
-     path: .
+conda:
+  environment: ci/docs.yml

MANIFEST.in

@@ -11,6 +11,7 @@ exclude .readthedocs.yaml
 exclude .web-compile-config.yml
 exclude requirements.txt
 recursive-exclude ci *.yml
+recursive-exclude ci *.yaml
 
 include LICENSE
 include MANIFEST.in

ci/docs.yml

@@ -0,0 +1,8 @@
+name: sphinx-pythia-theme-docs
+channels:
+    - conda-forge
+dependencies:
+    - python<3.12
+    - pip
+    - pip:
+      - -r ../requirements.txt

docs/_config.yml

@@ -3,8 +3,8 @@
 title: ""
 logo: images/dummy_logo_dark.svg
 author: the Project Pythia Community
-copyright: "2022"
-email: kpaul@ucar.edu
+copyright: "2024"
+email: projectpythia@ucar.edu
 description: >- # this means to ignore newlines
   This is an example book built with Jupyter Books.
 
@@ -104,7 +104,7 @@ sphinx:
   extra_extensions:
     - ablog
     - sphinx_click.ext
-    - sphinx_inline_tabs
     - sphinx.ext.autodoc
     - sphinx.ext.intersphinx
     - sphinxcontrib.bibtex
+    - sphinxcontrib.youtube

docs/about.rst

@@ -18,7 +18,7 @@ Where the Sphinx Book Theme places your ``html_logo`` at the top of the left sid
 Theme places the logo on the left of the top navigation bar.  The PyData Sphinx Theme allows the user
 to set the link attached to the logo with the ``logo_link`` option in your Sphinx ``html_theme_options``
 dictionary.  You can learn how to customize your logo on the
-`PyData Sphinx Theme documentation <https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/configuring.html#configure-project-logo>`_.
+`PyData Sphinx Theme documentation <https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/branding.html#customize-logo-link>`_.
 
 The links on the navigation bar can be set with the ``html_theme_options`` ``navbar_links`` option.
 This is a list of dictionaries containing a ``name`` key, ``url`` key, and an ``external`` key.  The
@@ -31,7 +31,7 @@ Additionally, the
 (``external_links``) option from the PyData Sphinx Theme still works, and these links
 will be displayed after any links specified by the ``navbar_links`` option.
 
-.. tabbed:: Sphinx
+.. tab-set-code:: Sphinx
 
    .. code-block:: python
 
@@ -46,7 +46,7 @@ will be displayed after any links specified by the ``navbar_links`` option.
           ]
       }
 
-.. tabbed:: Jupyter Book
+.. tab-set-code:: Jupyter Book
 
    .. code-block:: yaml
 
@@ -75,34 +75,40 @@ Footer Bar
 ----------
 
 In addition to the top navigation bar at the top of each page, the full-width footer
-bar from the PyData Sphinx Theme has been readded to the bottom of every page.  By default, the
-footer bar only contains copyright and additional information about the Sphinx version (if configured).
+bar from the PyData Sphinx Theme has been re-added to the bottom of every page.
+
+.. note::
+   While PyData Sphinx Theme has ``footer_start``, ``footer_center``, and ``footer_end`` to set,
+our theme supports only ``footer_start``, and allows to add below structures into it.
+
+By default, the footer bar only contains copyright and additional information about the Sphinx version (if configured).
 Three additional sections can be added to the footer: a *logo bar*, a *bottom navigation menu*, and
 an *extras* section.
 
 Footer Logo Bar
 ^^^^^^^^^^^^^^^
 
 The *logo bar* section can be used to add logo images for various partner or collaboration
-institutions, products, or other entities involved with site itself.  These are spread out
+institutions, products, or other entities involved with site itself. These are spread out
 evenly across the footer in a light-gray full-width box.
 
 To add logo images to the *logo bar* in the footer, use the ``footer_logos`` option of the
-``html_theme_options``.  The name given to each logo is used as the alternate name of
-the image in HTML.
+``html_theme_options`` and then add it to ``footer_start``.  The name given to each logo is
+used as the alternate name of the image in HTML.
 
-.. tabbed:: Sphinx
+.. tab-set-code:: Sphinx
 
    .. code-block:: python
 
       html_theme_options = {
           'footer_logos': {
               'name1': 'images/logo1.svg',
               'name2': 'images/logo2.svg',
-          }
+          },
+          "footer_start": ["footer-logos"]
       }
 
-.. tabbed:: Jupyter Book
+.. tab-set-code:: Jupyter Book
 
    .. code-block:: yaml
 
@@ -125,7 +131,7 @@ key containing any CSS classes to add to the HTML column division, and an ``item
 list of dictionaries containing ``name``, ``url``, and ``external`` keys (with the same meaning as
 the keys in the ``navbar_links`` option above).
 
-.. tabbed:: Sphinx
+.. tab-set-code:: Sphinx
 
    .. code-block:: python
 
@@ -162,9 +168,10 @@ the keys in the ``navbar_links`` option above).
                   ],
               },
           ],
+          "footer_start": ["footer-menu"]
       }
 
-.. tabbed:: Jupyter Book
+.. tab-set-code:: Jupyter Book
 
    .. code-block:: yaml
 
@@ -195,7 +202,7 @@ Extra Footer
 The *extra* section of the footer is displayed immediately below the *info* section, and
 it can be set with the
 `extra footer <https://sphinx-book-theme.readthedocs.io/en/latest/customize/index.html?highlight=extra_footer#theme-options>`_
-(``extra_footer``) Sphinx Book Theme option.
+(``extra_footer``) Sphinx Book Theme option and then added to the ``footer_start``.
 
 Special Page layouts
 --------------------
@@ -227,7 +234,7 @@ Each *banner* section can be given its own background color or even background i
 To customize your own banners, all you need to do is add a ``banner`` directive to your
 section.
 
-.. tabbed:: reStructuredText
+.. tab-set-code:: reStructuredText
 
    .. code-block:: rst
 
@@ -237,7 +244,7 @@ section.
         caption: Photo by Jeff Stapleton from Pexels
         class: dark-banner
 
-.. tabbed:: Myst Markdown
+.. tab-set-code:: Myst Markdown
 
    .. code-block:: markdown
 
@@ -275,7 +282,7 @@ you need to declare which pages (by document name) will have the *banner* layout
 this, you need to declare the ``page_layouts`` option in the ``html_theme_options`` and
 tell the theme to use the ``page-banner.html`` template.
 
-.. tabbed:: Sphinx
+.. tab-set-code:: Sphinx
 
    .. code-block:: python
 
@@ -285,7 +292,7 @@ tell the theme to use the ``page-banner.html`` template.
           }
       }
 
-.. tabbed:: Jupyter Book
+.. tab-set-code:: Jupyter Book
 
    .. code-block:: yaml