Merge pull request #14 from jburel/organise

organise the releases under one section
ome · Aug 19, 2024 · 54e62e7 · 54e62e7
2 parents 83abc79 + e00990b
commit 54e62e7
Show file tree

Hide file tree

Showing 6 changed files with 59 additions and 13 deletions.
diff --git a/docs/components-release.rst b/docs/components-release.rst
@@ -0,0 +1,17 @@
+Components release
+==================
+
+The following sections summarize the release process of the various components of the software stack.
+Note this is not an exhaustive list of all tools release process.
+
+
+.. toctree::
+    :maxdepth: 1
+
+    cpp-development
+    gradle-development
+    java-development
+    python-components
+    omero-release-process
+    omero-web-release-process
+
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,6 +15,7 @@
 
 import sys
 import os
+import shutil
 
 linkcheck_ignore = []
 extensions = ['sphinx.ext.extlinks']
@@ -245,3 +246,28 @@
     r'https://oss.sonatype.org/.*',  # Requires login
     github_root + 'ome/'
 ]
+
+def copy_legacy_redirects(app, exception):
+    """
+    see: https://tech.signavio.com/2017/managing-sphinx-redirects
+    """
+    print("Adding redirects:")
+    redirect_files = [
+        'python-development.html',
+
+    ]
+    if app.builder.name == 'html':
+        for html_src_path in redirect_files:
+            target_path = app.outdir + '/' + html_src_path
+            src_path = app.srcdir + '/' + html_src_path
+            if os.path.isfile(src_path):
+                target_dir = os.path.dirname(target_path)
+                if not os.path.exists(target_dir):
+                    os.makedirs(target_dir)
+                shutil.copyfile(src_path, target_path)
+                print("  %s" % html_src_path)
+
+
+def setup(app):
+    app.connect('build-finished', copy_legacy_redirects)
+
diff --git a/docs/cpp-development.rst b/docs/cpp-development.rst
@@ -1,5 +1,5 @@
-C++ components
-==============
+C++ components (deprecated)
+===========================
 
 This document describes the conventions and process used by the OME team for
 developing, maintaining and releasing its C++ components.

diff --git a/docs/index.rst b/docs/index.rst
@@ -17,19 +17,14 @@ be valuable to a wider audience.
     team-communication
     team-workflow
     ansible-development
-    java-development
-    gradle-development
-    cpp-development
     development-tools
     deployment-tools
     continuous-integration
     editing-docs
     jekyll
     data-model-schema
     schema-changes
-    python-development
-    omero-release-process
-    omero-web-release-process
+    components-release
 
 Information specific to developing OMERO, the OME Data Model and file formats,
 and Bio-Formats can be found in their respective developer documentation

diff --git a/docs/python-development.rst → docs/python-components.rst b/docs/python-development.rst → docs/python-components.rst
@@ -1,5 +1,5 @@
-Python development
-==================
+Publish to PyPI
+===============
 
 Release process
 ---------------
@@ -52,9 +52,9 @@ To complete the release, push the master branch and the release tag to origin::
 
     $ git push origin master v5.8.0
 
-Publishing to Pypi
-==================
+Publishing
+----------
 
-Many of the OME Python repositories use GitHub actions to publish to `Pypi <https://pypi.org/>`_
+Many of the OME Python repositories use GitHub actions to publish to PyPI_
 when a new tag is created and pushed to GitHub.
 This is typically specified in a file such as `.github/workflows/publish_pypi.yml`.
diff --git a/docs/python-development.html b/docs/python-development.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta http-equiv="refresh" content="1; url=../" />
+    <script>
+      window.location.href = "python-components.html"
+    </script>
+  </head>
+</html>