From d4e06607b0204345ffb06cf3c9ffc03983d54478 Mon Sep 17 00:00:00 2001 From: Lily Wang Date: Fri, 22 Sep 2023 00:14:00 +0100 Subject: [PATCH] advertise mdakits --- .github/workflows/gh-ci.yaml | 2 +- maintainer/conda/environment.yml | 2 +- package/CHANGELOG | 1 + package/doc/sphinx/source/conf.py | 7 +++++++ package/pyproject.toml | 2 +- 5 files changed, 11 insertions(+), 3 deletions(-) diff --git a/.github/workflows/gh-ci.yaml b/.github/workflows/gh-ci.yaml index a28d04eaeaf..8ba28b9bbb0 100644 --- a/.github/workflows/gh-ci.yaml +++ b/.github/workflows/gh-ci.yaml @@ -155,7 +155,7 @@ jobs: with: micromamba: true full-deps: true - extra-pip-deps: "docutils sphinx<7 sphinx-sitemap mdanalysis-sphinx-theme>=1.0.1 sphinxcontrib-bibtex pybtex pybtex-docutils" + extra-pip-deps: "docutils sphinx<7 sphinx-sitemap mdanalysis-sphinx-theme>=1.3.0 sphinxcontrib-bibtex pybtex pybtex-docutils" - name: build_srcs uses: ./.github/actions/build-src diff --git a/maintainer/conda/environment.yml b/maintainer/conda/environment.yml index a3f0a6d71db..a3dbb3400ed 100644 --- a/maintainer/conda/environment.yml +++ b/maintainer/conda/environment.yml @@ -13,7 +13,7 @@ dependencies: - h5py>=2.10 - hypothesis - joblib>=0.12 - - mdanalysis-sphinx-theme >=1.0.1 + - mdanalysis-sphinx-theme >=1.3.0 - matplotlib>=3.2.2 - mmtf-python - mock diff --git a/package/CHANGELOG b/package/CHANGELOG index e84166fe09f..cb36ff3341d 100644 --- a/package/CHANGELOG +++ b/package/CHANGELOG @@ -33,6 +33,7 @@ Enhancements * Added a warning about charge neutrality to the documentation of `DielectricConstant` (Issue #4262, PR #4263) * Add support for reading chainID info from prmtop amber topologies (PR #4007) + * Adds external sidebar links (Issue #4296) Changes * The `mda-xdrlib` module is now a core dependency of MDAnalysis diff --git a/package/doc/sphinx/source/conf.py b/package/doc/sphinx/source/conf.py index e66d330ef06..a1a461ed14b 100644 --- a/package/doc/sphinx/source/conf.py +++ b/package/doc/sphinx/source/conf.py @@ -161,8 +161,15 @@ class KeyStyle(UnsrtStyle): # a list of builtin themes. html_theme = 'mdanalysis_sphinx_theme' +extra_nav_links = {} +extra_nav_links["MDAnalysis"] = "http://mdanalysis.org" +extra_nav_links["User guide"] = "http://userguide.mdanalysis.org" +extra_nav_links["MDAKits"] = "https://mdakits.mdanalysis.org/" + + html_theme_options = { "mda_official": True, + "extra_nav_links": extra_nav_links, } # Theme options are theme-specific and customize the look and feel of a theme diff --git a/package/pyproject.toml b/package/pyproject.toml index 31e4896dc84..83a7da80e82 100644 --- a/package/pyproject.toml +++ b/package/pyproject.toml @@ -91,7 +91,7 @@ analysis = [ doc = [ "sphinx", "sphinx-sitemap", - "mdanalysis-sphinx-theme", + "mdanalysis-sphinx-theme>=1.3.0", "sphinxcontrib-bibtex", "pybtex", "pybtex-docutils",