From f06e922c25a373b93fb423ef16db28c5588a1254 Mon Sep 17 00:00:00 2001 From: Sina Rohde <s.rohde@indiscale.com> Date: Thu, 1 Feb 2024 11:32:49 +0100 Subject: [PATCH] added section related projects --- doc/conf.py | 2 +- doc/index.rst | 4 +++- doc/related_projects/index.rst | 23 +++++++++++++++++++++++ 3 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 doc/related_projects/index.rst diff --git a/doc/conf.py b/doc/conf.py index 5fdc05d..b91de6f 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -22,7 +22,7 @@ import sphinx_rtd_theme # -- Project information ----------------------------------------------------- project = 'caosdb-mysqlbackend' -copyright = '2021, IndiScale GmbH' +copyright = '2021 - 2024, IndiScale GmbH' author = 'Daniel Hornung' # The short X.Y version diff --git a/doc/index.rst b/doc/index.rst index 3924201..eac53ba 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -10,7 +10,9 @@ Welcome to documentation of CaosDB's MySQL Backend! Getting started <README_SETUP> Concepts <concepts> Maintenance - API documentation<functions> + API documentation <functions> + Related Projects <related_projects/index> + Back to Overview <https://docs.indiscale.com/> This documentation helps you to :doc:`get started<README_SETUP>`, explains the most important :doc:`concepts<concepts>` . diff --git a/doc/related_projects/index.rst b/doc/related_projects/index.rst new file mode 100644 index 0000000..2caa04e --- /dev/null +++ b/doc/related_projects/index.rst @@ -0,0 +1,23 @@ +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. + + :`WebUI <caosdb-webui>`_: The default web frontend for the LinkAhead server. + + :`PyLinkAhead <caosdb-pylib>`_: The LinkAhead Python library. + + :`Advanced user tools <caosdb-advanced-user-tools>`_: The advanced Python tools for 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