From efd24e84f01ea3b16bb21f5de1ffbca456de382a Mon Sep 17 00:00:00 2001 From: Sina Rohde <s.rohde@indiscale.com> Date: Wed, 31 Jan 2024 11:56:33 +0100 Subject: [PATCH] new section "related projects" --- src/doc/conf.py | 2 +- src/doc/index.rst | 3 +++ src/doc/related_projects/index.rst | 25 +++++++++++++++++++++++++ 3 files changed, 29 insertions(+), 1 deletion(-) create mode 100644 src/doc/related_projects/index.rst diff --git a/src/doc/conf.py b/src/doc/conf.py index a45097e8..e13d7724 100644 --- a/src/doc/conf.py +++ b/src/doc/conf.py @@ -29,7 +29,7 @@ import sphinx_rtd_theme # noqa: E402 # -- Project information ----------------------------------------------------- project = 'caosdb-caoscrawler' -copyright = '2021, MPIDS' +copyright = '2024, IndiScale' author = 'Alexander Schlemmer' # The short X.Y version diff --git a/src/doc/index.rst b/src/doc/index.rst index 20f335f7..8a02ec62 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -15,6 +15,9 @@ CaosDB-Crawler Documentation Macros<macros> How to upgrade<how-to-upgrade> API documentation<_apidoc/modules> + Related Projects<related_projects/index> + + Back to Overview <https://docs.indiscale.com/> diff --git a/src/doc/related_projects/index.rst b/src/doc/related_projects/index.rst new file mode 100644 index 00000000..3329b394 --- /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. + + :`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