diff options
| -rw-r--r-- | doc/RELEASE_WALKTHROUGH.rst | 9 | ||||
| -rw-r--r-- | doc/source/_static/versions.json | 62 | ||||
| -rw-r--r-- | doc/source/conf.py | 4 |
3 files changed, 7 insertions, 68 deletions
diff --git a/doc/RELEASE_WALKTHROUGH.rst b/doc/RELEASE_WALKTHROUGH.rst index 9beec6e01..7d865488f 100644 --- a/doc/RELEASE_WALKTHROUGH.rst +++ b/doc/RELEASE_WALKTHROUGH.rst @@ -282,6 +282,11 @@ If the release series is a new one, you will need to add a new section to the $ gvim index.html +/'insert here' +Further, update the version-switcher json file to add the new release and +update the version marked `(stable)`: + + $ gvim _static/versions.json + Otherwise, only the ``zip`` and ``pdf`` links should be updated with the new tag name:: @@ -354,8 +359,4 @@ Checkout main and forward port the documentation changes:: $ git commit -a -m"REL: Update main after 1.21.0 release." $ git push origin HEAD -Only for new releases the version-switcher file ``doc/source/_static/versions.json`` -should now be updated to insert the new release after the "stable" entry and the -release of the "stable" entry fixed. This change only lives on the main branch. - Go to GitHub and make a PR. diff --git a/doc/source/_static/versions.json b/doc/source/_static/versions.json deleted file mode 100644 index 104a30de7..000000000 --- a/doc/source/_static/versions.json +++ /dev/null @@ -1,62 +0,0 @@ -[ - { - "name": "dev", - "version": "devdocs", - "url": "https://numpy.org/devdocs/" - }, - { - "name": "1.22 (stable)", - "version": "stable", - "url": "https://numpy.org/doc/stable/" - }, - { - "name": "1.22", - "version": "1.22", - "url": "https://numpy.org/doc/1.22/" - }, - { - "name": "1.21", - "version": "1.21", - "url": "https://numpy.org/doc/1.21/" - }, - { - "name": "1.20", - "version": "1.20", - "url": "https://numpy.org/doc/1.20/" - }, - { - "name": "1.19", - "version": "1.19", - "url": "https://numpy.org/doc/1.19/" - }, - { - "name": "1.18", - "version": "1.18", - "url": "https://numpy.org/doc/1.18/" - }, - { - "name": "1.17", - "version": "1.17", - "url": "https://numpy.org/doc/1.17/" - }, - { - "name": "1.16", - "version": "1.16", - "url": "https://numpy.org/doc/1.16/" - }, - { - "name": "1.15", - "version": "1.15", - "url": "https://numpy.org/doc/1.15/" - }, - { - "name": "1.14", - "version": "1.14", - "url": "https://numpy.org/doc/1.14/" - }, - { - "name": "1.13", - "version": "1.13", - "url": "https://numpy.org/doc/1.13/" - } -] diff --git a/doc/source/conf.py b/doc/source/conf.py index 854885270..ef31cfaac 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -171,7 +171,7 @@ html_logo = '_static/numpylogo.svg' html_favicon = '_static/favicon/favicon.ico' -# Set up the version switcher. The versions.json is stored in the devdocs. +# Set up the version switcher. The versions.json is stored in the doc repo. if os.environ.get('CIRCLE_JOB', False) and \ os.environ.get('CIRCLE_BRANCH', '') != 'main': # For PR, name is set to its ref @@ -193,7 +193,7 @@ html_theme_options = { "navbar_end": ["version-switcher", "navbar-icon-links"], "switcher": { "version_match": switcher_version, - "json_url": "https://numpy.org/devdocs/_static/versions.json", + "json_url": "https://numpy.org/doc/_static/versions.json", }, } |