diff --git a/README_SETUP.md b/README_SETUP.md index 485835fdae10239cb4329b0f9b6708c1b020fa2a..fdd6b9f48990fad4bf9259f35ef5617ad0b9beca 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -22,6 +22,7 @@ --> # Getting Started with the Web Interface + Here, we document how to install and build the CaosDB Web Interface. If you are only interested in how to use it, please continue [here](tutorials/first_steps.html) diff --git a/src/doc/extension/display_of_properties.rst b/src/doc/extension/display_of_properties.rst index 29d254c15a8409047ac6087030c4a35093db3ac5..e19b7030b2a93d7c9a5eed772233ccbfa02b145b 100644 --- a/src/doc/extension/display_of_properties.rst +++ b/src/doc/extension/display_of_properties.rst @@ -34,10 +34,10 @@ property, and the names of the roles and/or users from whom it should be hidden. "roles": ["list", "of", "roles"], "users": ["list", "of", "users"] }, - ... + // ... ] }, - ... + // ... } In the same way but using the ``show`` keyword, properties can be hidden for @@ -53,10 +53,10 @@ everyone **but** the specified users/roles: "roles": ["list", "of", "roles"], "users": ["list", "of", "users"] }, - ... + // ... ] }, - ... + // ... } @@ -90,7 +90,7 @@ configured in the same configuration file as above, i.e., in "RecordTypeName": { "order": ["ordered", "list", "of", "properties"] }, - ... + // ... } This ensures that the properties of all entities with the declared types are diff --git a/src/doc/index.rst b/src/doc/index.rst index 24c394349a045bf276c4252a2fde47feae6f533c..73277291878cb24ef1ed121d93944d2614e5224b 100644 --- a/src/doc/index.rst +++ b/src/doc/index.rst @@ -12,11 +12,12 @@ Welcome to the documentation of CaosDB's web UI! Concepts <concepts> administration/index.rst Extending the UI <extension> - API <api/index> + .. + API <api/index> 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/index>`. Indices and tables