Add link to older versions of the documentation (#413)

* Add link to older versions of the documentation

* fix math

* update links to documentation

* Fix greater than

* fix text

* Update versions.rst

.conda/meta.yaml

@@ -59,7 +59,7 @@ test:
     - pytest --pyargs scirpy -m "not extra"
 
 about:
-  home: https://scverse.org/scirpy
+  home: https://scirpy.scverse.org
   dev_url: https://github.com/scverse/scirpy
   license: BSD-3
   license_family: BSD

CONTRIBUTING.md

@@ -1,5 +1,5 @@
 # Contributing
 
 We welcome contributions to Scirpy! Please have a look at the [developer
-docs](https://scverse.org/scirpy/develop/developer_docs.html) for
+docs](https://scirpy.scverse.org/en/latest/contributing.html) for
 useful information around making a pull-request.

README.md

@@ -112,6 +112,6 @@ You can cite the scverse publication as follows:
 [changelog]: https://scirpy.readthedocs.io/latest/changelog.html
 [link-docs]: https://scirpy.readthedocs.io
 [link-api]: https://scirpy.readthedocs.io/latest/api.html
-[link-tutorial]: https://scverse.org/scirpy/latest/tutorials.html
+[link-tutorial]: https://scirpy.scverse.org/en/latest/tutorials.html
 [Docker]: https://www.docker.com/
 [Podman]: https://podman.io/

docs/index.md

@@ -13,5 +13,6 @@ ir-biology
 glossary
 contributing.md
 changelog.md
+versions
 zzz_bibliography
 ```

docs/versions.rst

@@ -0,0 +1,23 @@
+Other versions
+==============
+
+.. note::
+    **Versions of the documentation ≥v0.13 are hosted on readthedocs and can be accessed via the
+    sidebar menu at the bottom left.**
+
+Older versions of the documentation are hosted on GitHub pages for historical reasons and can be accessed via
+the following list:
+
+.. raw:: html
+
+   <ul id="versions_container">
+   </ul>
+   <script type="text/javascript">
+   	fetch("https://scverse.org/scirpy/versions/versions.json")
+	   .then(response => response.json())
+	   .then(versions => versions.forEach((x, i) => {
+	   	document.getElementById("versions_container").innerHTML += '<li><a href="https://scverse.org/scirpy/tags/' + x + '/">' + x + '</a></li>\n'
+           })).catch((error) => {
+	       document.getElementById("versions_container").innerHTML = "Could not download version information..."
+	   })
+   </script>

src/scirpy/pp/__init__.py

@@ -14,8 +14,7 @@ def merge_with_ir(*args, **kwargs):
             """\
             This function has been removed in v0.13.
             Use MuData instead: mdata = MuData({"gex": adata, "airr": adata_ir})
-            See https://scverse.org/scirpy/latest/data-structure.html
-            """
+            See https://scirpy.scverse.org/en/latest/data-structure.html"""
         )
     )
 

src/scirpy/util/__init__.py

@@ -347,7 +347,7 @@ def _check_airr_key_in_obsm(self):
                     dedent(
                         f"""\
                         No AIRR data found in adata.obsm['{self._airr_key}'].
-                        See https://scverse.org/scirpy/develop/data-structure.html for more info about the scirpy data structure.
+                        See https://scirpy.scverse.org/en/latest/data-structure.html for more info about the scirpy data structure.
                         """
                     )
                 )