Skip to content

Commit

Permalink
Merge pull request #1022 from xylar/fix-sphinx-multiversion
Browse files Browse the repository at this point in the history
More fixes to sphinx multiversion
  • Loading branch information
xylar authored Oct 19, 2024
2 parents 04abf48 + 48ddd5e commit 48f973f
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -28,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

Expand Down Expand Up @@ -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:
```
Expand Down
6 changes: 6 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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+$'
Expand Down

0 comments on commit 48f973f

Please sign in to comment.