Skip to content
Snippets Groups Projects
Commit 2b88f3c1 authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

DOC: add README_SETUP to doc

parent a830a8a9
No related branches found
No related tags found
No related merge requests found
...@@ -82,7 +82,7 @@ with the then current version of the stored entities. ...@@ -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`, * Alternatively, to run the tests in a containerized MariaDB instance, run `make test-docker`,
followed by `make test-docker-stop`. followed by `make test-docker-stop`.
# Documentation # ## Documentation #
Build documentation in `build/` with `make doc`. Build documentation in `build/` with `make doc`.
......
...@@ -6,6 +6,8 @@ ...@@ -6,6 +6,8 @@
# list see the documentation: # list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html # https://www.sphinx-doc.org/en/master/usage/configuration.html
import sphinx_rtd_theme
# -- Path setup -------------------------------------------------------------- # -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory, # If extensions (or modules to document with autodoc) are in another directory,
...@@ -47,6 +49,7 @@ extensions = [ ...@@ -47,6 +49,7 @@ extensions = [
# 'autoapi.extension', # 'autoapi.extension',
# 'sphinx.ext.intersphinx', # 'sphinx.ext.intersphinx',
# 'sphinx.ext.napoleon', # For Google style docstrings # 'sphinx.ext.napoleon', # For Google style docstrings
"sphinx_rtd_theme",
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
...@@ -82,7 +85,7 @@ pygments_style = None ...@@ -82,7 +85,7 @@ pygments_style = None
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the
...@@ -93,7 +96,7 @@ html_theme = 'alabaster' ...@@ -93,7 +96,7 @@ html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # 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 # Custom sidebar templates, must be a dictionary that maps document names
# to template names. # to template names.
......
Welcome to caosdb-server's documentation! Welcome to documentation of CaosDB's MySQL Backend!
========================================= ===================================================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
:hidden: :hidden:
Getting started <getting_started> Getting started <README_SETUP>
Concepts <concepts> Concepts <concepts>
tutorials tutorials
API documentation<functions> API documentation<functions>
Welcome to the MySQL/MariaDB backend of CaosDB! This documentation helps you to :doc:`get started<README_SETUP>`, explains the most important
This documentation helps you to :doc:`get started<getting_started>`, explains the most important
:doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`. :doc:`concepts<concepts>` and offers a range of :doc:`tutorials<tutorials>`.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment