update pyterrier-artifacts to main

documentation/conf.py

@@ -12,14 +12,16 @@
 #
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../'))
+
+sys.path.insert(0, os.path.abspath("./sphinxext"))
+sys.path.insert(0, os.path.abspath("../"))
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'TIRA'
-copyright = '2024, Webis'
-author = 'Webis'
+project = "TIRA"
+copyright = "2024, Webis"
+author = "Webis"
 
 
 # -- General configuration ---------------------------------------------------
@@ -28,42 +30,43 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'sphinx.ext.autodoc',
-    'sphinx.ext.todo',
-    'sphinx.ext.doctest',
-    'sphinx.ext.viewcode',
-    'sphinx_design',
-    'sphinxcontrib.plantuml',
-    'sphinxcontrib.umlet',
-    'myst_parser',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.todo",
+    "sphinx.ext.doctest",
+    "sphinx.ext.viewcode",
+    "sphinx_design",
+    "sphinxcontrib.plantuml",
+    "sphinxcontrib.umlet",
+    "myst_parser",
+    "openapi",
 ]
 
-todo_include_todos=True
-python_display_short_literal_types=True
-python_use_unqualified_type_names=True
-viewcode_line_numbers=True
+todo_include_todos = True
+python_display_short_literal_types = True
+python_use_unqualified_type_names = True
+viewcode_line_numbers = True
 
-doctest_global_setup = '''
+doctest_global_setup = """
 from tira.io_utils import *
-'''
+"""
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'furo'
-html_title = 'TIRA'
-language = 'en'
+html_theme = "furo"
+html_title = "TIRA"
+language = "en"
 
 html_logo = "https://assets.tira.io/tira-icons/tira-logo.svg"
 html_theme_options: Dict[str, Any] = {
@@ -87,15 +90,15 @@
 }
 
 
-plantuml_output_format = 'svg_img'
+plantuml_output_format = "svg_img"
 
 umlet_binary_path = "/usr/share/umlet/Umlet/umlet.sh"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 html_css_files = [
-    'custom.css',
-]
+    "custom.css",
+]

documentation/development/changelog.rst

@@ -18,6 +18,12 @@ Removed
 
 
 
-Alpha
------
-- Initial release
+
+
+
+
+0.0.136
+-------
+For more information, we refer to the `Release Page <https://github.com/tira-io/tira/releases/tag/0.0.136>`_.
+
+- First Release using the Release Pipeline

documentation/development/devenvironment.rst

@@ -87,7 +87,7 @@ The development environment is quite similar to the production environment and c
 .. umlet-figure:: images/devenv.uxf
 
 Lookup Tables for Useful Information
------------------------------------
+------------------------------------
 Root Password
 ~~~~~~~~~~~~~
 You may occasionally need root privileges in the development container. The password for the root user is ``1234`` (if

documentation/development/documentation.rst

@@ -1,5 +1,5 @@
-Documentation
-=============
+Adding Documentation
+====================
 General
 -------
 All files relevant to TIRA's documentation can be found in the `documentation` subdirectory of the

documentation/development/specification/index.rst

@@ -14,7 +14,7 @@ Specification
       :link-type: doc
 
    .. grid-item-card:: :octicon:`broadcast` REST API
-      :link: restapi
+      :link: restapi/index
       :link-type: doc
 
    .. grid-item-card:: :octicon:`plug` Technology
@@ -28,5 +28,5 @@ Specification
 
     userstories
     architecture
-    restapi
+    restapi/index
     technology/index

documentation/development/specification/restapi.rst → documentation/development/specification/restapi/guidelines.rst

@@ -1,6 +1,3 @@
-REST-API
-===================
-
 Guidelines
 ----------
 

documentation/development/specification/restapi/index.rst

@@ -0,0 +1,12 @@
+REST-API
+========
+
+.. toctree::
+    :maxdepth: 2
+    :glob:
+    :hidden:
+
+    *
+
+.. include-openapi:: ./development/specification/rest-api.yml
+    :filter-tags: v1

documentation/development/specification/technology/index.rst

@@ -10,4 +10,7 @@ Technology
 
 Other Resources
 ---------------
-* `Semantic Versioning <https://semver.org>`_
+* `Semantic Versioning <https://semver.org>`_
+* :RFC:`3986` -- URI Syntax (esp. Section 3)
+* :RFC:`4395` -- Registration Guidelines for new URI Schemes
+* :RFC:`8615` -- ``/.well-known`` URIs

documentation/organizers/intro.rst

@@ -59,4 +59,5 @@ How do I...
 
 .. _orgfaq:
 .. rubric:: Frequently Asked Questions
+
 No questions yet :material-regular:`mood;1.5em;sd-text-success`.

documentation/participants/participate.rst

@@ -8,6 +8,7 @@ Participating in a Shared Task
 
 
 .. _JoinTask:
+
 Joining a Task and preparing your Environment
 ---------------------------------------------
 
@@ -59,6 +60,7 @@ out more):
 
 
 .. _SubmitSubmission:
+
 Submitting your Submission
 --------------------------
 At this point, you came up with a brilliant idea and would like to submit it to TIRA for evaluation and to take pride in