Separate v1 specs and v2 draft; add redirect

PEtab-dev · Jul 3, 2024 · 02716b3 · 02716b3
1 parent 298ed8b
commit 02716b3
Show file tree

Hide file tree

Showing 5 changed files with 735 additions and 3 deletions.
diff --git a/.rtd_pip_reqs.txt b/.rtd_pip_reqs.txt
@@ -36,3 +36,4 @@ sphinxcontrib-qthelp==1.0.7
 sphinxcontrib-serializinghtml==1.1.10
 urllib3==2.2.1
 wheel==0.43.0
+sphinx-reredirects==0.1.4
diff --git a/doc/conf.py b/doc/conf.py
@@ -40,6 +40,7 @@
     'm2r2',
     'sphinx.ext.autosummary',
     'sphinx_markdown_tables',
+    'sphinx_reredirects',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -71,6 +72,11 @@
     '.md': 'markdown',
 }
 
+# Redirects for moved files
+redirects = {
+    "documentation_data_format": "v1/documentation_data_format.html",
+}
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

diff --git a/doc/index.rst b/doc/index.rst
@@ -5,7 +5,8 @@
    :maxdepth: 3
    :caption: Data format
 
-   Data format <documentation_data_format.rst>
+   PEtab v1 specs <v1/documentation_data_format.rst>
+   PEtab v2 draft <v2/documentation_data_format.rst>
    tutorial
 
 .. toctree::