(Draft) New Data Model

LICENSES/W3C-20150513.txt

@@ -0,0 +1,17 @@
+This work is being provided by the copyright holders under the following license.
+
+License
+By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.
+
+Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
+
+     • The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
+     • Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice should be included.
+     • Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright (c) [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."
+
+Disclaimers
+THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.
+
+COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.
+
+The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders.

REUSE.toml

@@ -17,3 +17,9 @@ path = ["REUSE.toml"]
 precedence = "aggregate"
 SPDX-FileCopyrightText = "German Aerospace Center (DLR), Helmholtz-Zentrum Dresden-Rossendorf, Forschungszentrum Jülich"
 SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = ["src/**/*.py", "test/**/*.py"]
+precedence = "aggregate"
+SPDX-FileCopyrightText = "German Aerospace Center (DLR), Helmholtz-Zentrum Dresden-Rossendorf, Forschungszentrum Jülich"
+SPDX-License-Identifier = "Apache-2.0"

conftest.py

@@ -0,0 +1,9 @@
+# SPDX-FileCopyrightText: 2026 German Aerospace Center (DLR)
+#
+# SPDX-License-Identifier: Apache-2.0
+
+# SPDX-FileContributor: Michael Fritzsche
+
+# add option to pass zenodo sandbox auth token to pytest to run ./test/hermes_test/commands/deposit/test_invenio_e2e.py
+def pytest_addoption(parser):
+    parser.addoption("--sandbox_auth", action="store", default=None)

docs/source/_static/custom.css

@@ -6,6 +6,7 @@
 
  /*
   * SPDX-FileContributor: Oliver Bertuch
+  * SPDX-FileContributor: Michael Fritzsche
   */
 
 img.member {
@@ -22,4 +23,36 @@ img.badge-icon {
     img.member {
         max-width: 23%;
     }
+}
+
+img {
+    display: block;
+    margin: auto;
+}
+
+.bd-page-width {
+    max-width: none !important;
+}
+
+@media (min-width: 1200px) {
+    .bd-article-container {
+        max-width: none !important;
+    }
+}
+
+.bd-article-container {
+    max-width: 100%;
+}
+
+.bd-sidebar-primary.bd-sidebar {
+    max-width: min-content;
+}
+
+.bd-docs-nav {
+    min-width: max-content;
+}
+
+.bd-sidebar-secondary{
+    max-width: 15%;
+    width: max-content;
 }

docs/source/conf.py

@@ -39,7 +39,7 @@ def read_from_pyproject(file_path="../../pyproject.toml"):
         data = toml.load(file_path)
 
         # Navigate to the authors metadata
-        metadata = data.get("tool", {}).get("poetry", {})
+        metadata = data.get("project", {})
         if not metadata:
             return "No metadata found in pyproject.toml"
         return metadata
@@ -56,7 +56,7 @@ def read_authors_from_pyproject():
     if not authors:
         return "No authors metadata found in pyproject.toml"
     # Convert the list of authors to a comma-separated string
-    return ", ".join([a.split(" <")[0] for a in authors])
+    return ", ".join([author["name"] for author in authors])
 
 def read_version_from_pyproject():
     metadata = read_from_pyproject()
@@ -73,7 +73,7 @@ def read_version_from_pyproject():
 author = read_authors_from_pyproject()
 
 # The full version, including alpha/beta/rc tags
-release = read_version_from_pyproject()
+version = release = read_version_from_pyproject()
 
 
 # -- General configuration ---------------------------------------------------
@@ -131,6 +131,9 @@ def read_version_from_pyproject():
 autoapi_dirs = ["../../src"]
 autoapi_root = "api"
 autoapi_ignore = ["*__main__*"]
+autoapi_options = [
+    "members", "undoc-members", "private-members", "special-members", "show-inheritance", "show-module-summary"
+]
 
 # -- Options for HTML output -------------------------------------------------
 
@@ -161,6 +164,7 @@ def read_version_from_pyproject():
     "repository_url": "https://github.com/hermes-hmc/hermes",
     "use_repository_button": True,
     "navigation_with_keys": False,
+    "max_navbar_depth": -1
 }
 
 html_css_files = [
@@ -182,3 +186,20 @@ def read_version_from_pyproject():
 # -- Options for sphinx-togglebutton -----------------------------------------
 
 togglebutton_hint = "Click to show screenshot"
+
+
+# TODO: remove this workaround and remove "undoc-members" from autoapi_options once everything is documented
+# This removes all generated entries for known documented classes (because autoapi will add all attributes
+# it finds in the code no matter if they are described in a class doc string or not).
+def autoapi_skip_member(app, obj_type, name, obj, skip, options):
+    if obj_type == "attribute":
+        if any(documented_type in obj.id for documented_type in [
+            "Collect", "HermesCache", "HermesContext", "HermesMergeError", "ld_container", "ld_context", "ld_dict",
+            "ld_list", "ld_merge_dict", "ld_merge_list", "MergeSet"
+        ]):
+            return True
+
+    return skip
+
+def setup(app):
+    app.connect("autoapi-skip-member", autoapi_skip_member)