Skip to content
GitLab
Explore
Sign in
Register
Primary navigation
Search or go to…
Project
C
caosdb-mysqlbackend
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container registry
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
caosdb
Software
caosdb-mysqlbackend
Commits
2b88f3c1
Commit
2b88f3c1
authored
4 years ago
by
Henrik tom Wörden
Browse files
Options
Downloads
Patches
Plain Diff
DOC: add README_SETUP to doc
parent
a830a8a9
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
README_SETUP.md
+1
-1
1 addition, 1 deletion
README_SETUP.md
doc/conf.py
+5
-2
5 additions, 2 deletions
doc/conf.py
doc/index.rst
+4
-6
4 additions, 6 deletions
doc/index.rst
with
10 additions
and
9 deletions
README_SETUP.md
+
1
−
1
View file @
2b88f3c1
...
...
@@ -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`
.
...
...
This diff is collapsed.
Click to expand it.
doc/conf.py
+
5
−
2
View file @
2b88f3c1
...
...
@@ -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.
...
...
This diff is collapsed.
Click to expand it.
doc/index.rst
+
4
−
6
View file @
2b88f3c1
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>`.
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment