From 2e7857d4b23b68f5200a8c0e7a5baf13cbc832f0 Mon Sep 17 00:00:00 2001
From: Daniel <d.hornung@indiscale.com>
Date: Wed, 3 May 2023 13:54:49 +0200
Subject: [PATCH] DOC: Fixed documentation problems.
---
README_SETUP.md | 3 ++-
doc/conf.py | 2 +-
doc/index.rst | 2 +-
doc/table_structure.md | 5 ++++-
4 files changed, 8 insertions(+), 4 deletions(-)
diff --git a/README_SETUP.md b/README_SETUP.md
index 211eaad..7623cfa 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -7,7 +7,8 @@
## Create the configuration
* Create an empty `.config` file. For the default values and the meaning of
- these default values see [config.defaults](config.defaults). For each
+ these default values see [config.defaults](https://gitlab.com/caosdb/caosdb-mysqlbackend/-/blob/main/config.defaults).
+ For each
parameter that you want to change, add a corresponding line in your `.config`
file. You probably want to change the passwords. As the passwords are stored
unencrypted in the `.config` file, make sure nobody else can read it.
diff --git a/doc/conf.py b/doc/conf.py
index 72f154b..20f21f4 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -69,7 +69,7 @@ master_doc = 'index'
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
diff --git a/doc/index.rst b/doc/index.rst
index b621ddb..652b855 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -1,6 +1,6 @@
Welcome to documentation of LinkAhead's MySQL Backend!
-===================================================
+======================================================
.. toctree::
:maxdepth: 2
diff --git a/doc/table_structure.md b/doc/table_structure.md
index 1641c56..ce0eaac 100644
--- a/doc/table_structure.md
+++ b/doc/table_structure.md
@@ -85,12 +85,15 @@ The type of properties is stored here. The columns are:
- `hash` :: Hash of the file contents, as binary. **TODO** Which algorithm?
- `checked_timestamp` :: Timestamp when last checked?
-## `feature_config` ##
+## feature_config ##
+
+```sql
+-------------------+---------+
| _key | _value |
+-------------------+---------+
| ENTITY_VERSIONING | ENABLED |
+-------------------+---------+
+```
A key-value store for features. Use the `is_feature_config` procedure to check for the status of
specific features.
--
GitLab