diff --git a/README_SETUP.md b/README_SETUP.md index cf1a2352e139baf7aaf18d69f4170afc00f159da..d17adb60a48262c188deebabe847df884d4d51b4 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 30fbb857d4ecd359d6b305e3e39f9ee5da4f26e8..03c39792c7bfb2bfe428f2ed954cdf6b01414083 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 87e9f2d3d525fc096547c38755fcb6024a20838d..b3de8d16b45d89790ef5b2f2cdb952f7031663b2 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>`.