From 0c505a26c04931d7c67f7892525163762cbe6cbe Mon Sep 17 00:00:00 2001 From: Sina Rohde <s.rohde@indiscale.com> Date: Thu, 1 Feb 2024 11:52:44 +0100 Subject: [PATCH] added section related projects --- src/doc/conf.py | 2 +- src/doc/index.rst | 4 +++- src/doc/related_projects/index.rst | 25 +++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 2 deletions(-) create mode 100644 src/doc/related_projects/index.rst diff --git a/src/doc/conf.py b/src/doc/conf.py index d3a5cab3..debaa44c 100644 --- a/src/doc/conf.py +++ b/src/doc/conf.py @@ -22,7 +22,7 @@ import sphinx_rtd_theme project = 'linkahead-webui' -copyright = '2022, IndiScale GmbH' +copyright = '2022 - 2024, IndiScale GmbH' author = 'Daniel Hornung' # The short X.Y version diff --git a/src/doc/index.rst b/src/doc/index.rst index 5ed1f417..f5b5d9c5 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -1,6 +1,6 @@ Welcome to the documentation of LinkAhead's web UI! -================================================ +=================================================== .. toctree:: :maxdepth: 2 @@ -12,6 +12,8 @@ Welcome to the documentation of LinkAhead's web UI! administration/index.rst Extending the UI <extension> API <api/index> + Related Projects <related_projects/index> + Back to overview <https://docs.indiscale.com/> .. note:: diff --git a/src/doc/related_projects/index.rst b/src/doc/related_projects/index.rst new file mode 100644 index 00000000..769c8126 --- /dev/null +++ b/src/doc/related_projects/index.rst @@ -0,0 +1,25 @@ +Related Projects +++++++++++++++++ + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + :hidden: + +.. container:: projects + + For in-depth documentation for users, administrators and developers, you may want to visit the subproject-specific documentation pages for: + + :`Server <caosdb-server>`_: The Java part of the LinkAhead server. + + :`MySQL backend <caosdb-mysqlbackend>`_: The MySQl/MariaDB components of the LinkAhead server. + + :`PyLinkAhead <caosdb-pylib>`_: The LinkAhead Python library. + + :`Advanced user tools <caosdb-advanced-user-tools>`_: The advanced Python tools for LinkAhead. + + :`LinkAhead Crawler <https://docs.indiscale.com//caosdb-crawler/>`_: The crawler is the main tool for automatic data integration in LinkAhead. + + :`LinkAhead <https://docs.indiscale.com/caosdb-deploy>`_: Your all inclusive LinkAhead software package. + + :`Back to Overview <https://docs.indiscale.com/>`_: LinkAhead Documentation. \ No newline at end of file -- GitLab