Update badges on overview page

qucontrol · Jun 2, 2024 · 367e00f · 367e00f
1 parent 6575c76
commit 367e00f
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 28 deletions.
diff --git a/docs/01_overview.rst b/docs/01_overview.rst
@@ -2,33 +2,37 @@
 Krotov Python Package
 =====================
 
-.. image:: https://img.shields.io/badge/github-qucontrol/krotov-blue.svg
-   :alt: Source code on Github
-   :target: https://github.com/qucontrol/krotov
-.. image:: https://img.shields.io/badge/docs-gh--pages-blue.svg
-   :alt: Documentation
-   :target: https://qucontrol.github.io/krotov
-.. image:: https://img.shields.io/pypi/v/krotov.svg
-   :alt: Krotov on the Python Package Index
-   :target: https://pypi.python.org/pypi/krotov
-.. image:: https://github.com/qucontrol/krotov/workflows/Docs/badge.svg?branch=master
-   :alt: Docs
-   :target: https://github.com/qucontrol/krotov/actions?query=workflow%3ADocs
-.. image:: https://github.com/qucontrol/krotov/workflows/Tests/badge.svg?branch=master
-   :alt: Tests
-   :target: https://github.com/qucontrol/krotov/actions?query=workflow%3ATests
-.. image:: https://codecov.io/gh/qucontrol/krotov/branch/master/graph/badge.svg
-   :alt: Codecov
-   :target: https://codecov.io/gh/qucontrol/krotov
-.. image:: https://img.shields.io/badge/License-BSD-green.svg
-   :alt: BSD License
-   :target: https://opensource.org/licenses/BSD-3-Clause
-.. image:: https://mybinder.org/badge_logo.svg
-   :alt: Launch Binder
-   :target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.2.1?filepath=docs%2Fnotebooks
-.. image:: https://img.shields.io/badge/DOI-10.21468/SciPostPhys.7.6.080-blue.svg
-   :alt: DOI
-   :target: https://doi.org/10.21468/SciPostPhys.7.6.080
+.. only:: html
+
+   .. image:: https://img.shields.io/badge/github-qucontrol/krotov-blue.svg
+      :alt: Source code on Github
+      :target: https://github.com/qucontrol/krotov
+   .. image:: https://img.shields.io/badge/docs-gh--pages-blue.svg
+      :alt: Documentation
+      :target: https://qucontrol.github.io/krotov
+   .. image:: https://img.shields.io/pypi/v/krotov.svg
+      :alt: Krotov on the Python Package Index
+      :target: https://pypi.python.org/pypi/krotov
+   .. image:: https://github.com/qucontrol/krotov/actions/workflows/docs.yml/badge.svg?branch=master
+      :alt: Docs
+      :target: https://github.com/qucontrol/krotov/actions?query=workflow%3ADocs
+   .. image:: https://github.com/qucontrol/krotov/actions/workflows/test.yml/badge.svg?branch=master
+      :alt: Tests
+      :target: https://github.com/qucontrol/krotov/actions?query=workflow%3ATests
+   .. image:: https://codecov.io/gh/qucontrol/krotov/branch/master/graph/badge.svg
+      :alt: Codecov
+      :target: https://codecov.io/gh/qucontrol/krotov
+   .. image:: https://img.shields.io/badge/License-BSD-green.svg
+      :alt: BSD License
+      :target: https://opensource.org/licenses/BSD-3-Clause
+   .. image:: https://mybinder.org/badge_logo.svg
+      :alt: Launch Binder
+      :target: https://mybinder.org/v2/gh/qucontrol/krotov/v1.2.1?filepath=docs%2Fnotebooks
+   .. image:: https://img.shields.io/badge/DOI-10.21468/SciPostPhys.7.6.080-blue.svg
+      :alt: DOI
+      :target: https://doi.org/10.21468/SciPostPhys.7.6.080
+
+
 
 Python implementation of Krotov's method for quantum optimal control.
 

diff --git a/scripts/release.py b/scripts/release.py
@@ -67,6 +67,7 @@ def make_release(package_name, fast_test=False):
         'README.md',
         join('docs', '09_examples.rst'),
         join('docs', 'index.rst'),
+        join('docs', 'overview.rst'),
     ]
     for filename in files_with_binder_links:
         set_binder_branch(filename, "v" + str(new_version))
@@ -91,10 +92,12 @@ def make_release(package_name, fast_test=False):
     files_with_released_binder_links = [
         'README.md',
         join('docs', 'index.rst'),
+        join('docs', 'overview.rst'),
     ]
     for filename in files_with_binder_links:
         if filename in files_with_released_binder_links:
-            # README and index always link to the latest released version
+            # README, index, and overview always link to the latest released
+            # version
             continue
         set_binder_branch(filename, 'master')
     set_binder_package_version(branch='master')