From dce4df1449a1cc1fb95a82015c57feefa77d24af Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Fri, 18 Oct 2024 18:08:54 -0600 Subject: [PATCH 1/3] Add docs version to sidebar --- docs/conf.py | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/conf.py b/docs/conf.py index d76c64bca..228f05752 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -219,6 +219,12 @@ github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/' +html_sidebars = { + "**": [ + "versions.html", + ], +} + # -- Options sphinx-multiversion ------------------------------------------- # Include tags like "tags/1.0.0" -- 1.7.2 doesn't build smv_tag_whitelist = r'^(?!1.7.2)\d+\.\d+.\d+$' From 204f342512dde2dd15919227d9e3e458cd8187ab Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Fri, 18 Oct 2024 18:09:37 -0600 Subject: [PATCH 2/3] Remove badge --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index af73ccff0..09e152660 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ # MPAS-Analysis -[![Build Status](https://dev.azure.com/MPAS-Dev/MPAS-Analysis%20testing/_apis/build/status/MPAS-Dev.MPAS-Analysis?branchName=develop)](https://dev.azure.com/MPAS-Dev/MPAS-Analysis%20testing/_build/latest?definitionId=2&branchName=develop) Analysis for simulations produced with Model for Prediction Across Scales (MPAS) components and the Energy Exascale Earth System Model (E3SM), which @@ -290,7 +289,7 @@ to be generated and is set up properly. ## Generating Documentation -Create a development environment as described above in "Installation for +Create a development environment as described above in "Installation for developers". Then run: To generate the `sphinx` documentation, run: ``` From 48ddd5eeaeb6a8a1aac5c00c27f07cbd2e001f54 Mon Sep 17 00:00:00 2001 From: Xylar Asay-Davis Date: Fri, 18 Oct 2024 18:11:00 -0600 Subject: [PATCH 3/3] Fix docs link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 09e152660..7c7ce60de 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ used those components. ## Documentation -[https://mpas-dev.github.io/MPAS-Analysis/latest/](https://mpas-dev.github.io/MPAS-Analysis/latest/) +[https://mpas-dev.github.io/MPAS-Analysis/develop/](https://mpas-dev.github.io/MPAS-Analysis/develop/) ## Installation for users