From 2b88f3c14b64d11e0d45503271f37e58530f5036 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <h.tomwoerden@indiscale.com>
Date: Thu, 10 Dec 2020 15:24:00 +0100
Subject: [PATCH] DOC: add README_SETUP to doc
---
README_SETUP.md | 2 +-
doc/conf.py | 7 +++++--
doc/index.rst | 10 ++++------
3 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/README_SETUP.md b/README_SETUP.md
index cf1a235..d17adb6 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -82,7 +82,7 @@ with the then current version of the stored entities.
* Alternatively, to run the tests in a containerized MariaDB instance, run `make test-docker`,
followed by `make test-docker-stop`.
-# Documentation #
+## Documentation #
Build documentation in `build/` with `make doc`.
diff --git a/doc/conf.py b/doc/conf.py
index 30fbb85..03c3979 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -6,6 +6,8 @@
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
+import sphinx_rtd_theme
+
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
@@ -47,6 +49,7 @@ extensions = [
# 'autoapi.extension',
# 'sphinx.ext.intersphinx',
# 'sphinx.ext.napoleon', # For Google style docstrings
+ "sphinx_rtd_theme",
]
# Add any paths that contain templates here, relative to this directory.
@@ -82,7 +85,7 @@ pygments_style = None
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -93,7 +96,7 @@ html_theme = 'alabaster'
# 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']
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
diff --git a/doc/index.rst b/doc/index.rst
index 87e9f2d..b3de8d1 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,20 +1,18 @@
-Welcome to caosdb-server's documentation!
-=========================================
+Welcome to documentation of CaosDB's MySQL Backend!
+===================================================
.. toctree::
:maxdepth: 2
:caption: Contents:
:hidden:
- Getting started <getting_started>
+ Getting started <README_SETUP>
Concepts <concepts>
tutorials
API documentation<functions>
-Welcome to the MySQL/MariaDB backend of CaosDB!
-
-This documentation helps you to :doc:`get started<getting_started>`, explains the most important
+This documentation helps you to :doc:`get started<README_SETUP>`, explains the most important
:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`.
--
GitLab