From c188d2340bb043d753889581f88a14fad19fa568 Mon Sep 17 00:00:00 2001 From: Joscha Schmiedt <joscha@schmiedt.dev> Date: Tue, 3 Sep 2024 09:55:00 +0200 Subject: [PATCH] Minor renamings in docs --- doc/Install_develop.rst | 30 +++++++++++++++++++----------- doc/cppapi/index.rst.in | 2 +- 2 files changed, 20 insertions(+), 12 deletions(-) diff --git a/doc/Install_develop.rst b/doc/Install_develop.rst index 5ae383f..0f1b193 100644 --- a/doc/Install_develop.rst +++ b/doc/Install_develop.rst @@ -182,23 +182,31 @@ Client Configuration -------------------- You can use a json file for the configuration of the client. See -``test/test_data/test_caosdb_client.json`` for an example. You may use +``test/test_data/test_linkahead_client.json`` for an example. You may use ``linkahead-client-configuration-schema.json`` to validate your schema. Typically, you will need to provide the path to your SSL certificate. The client will load the configuration file from the first existing file in the following locations (precedence from highest to lowest): -1. A file specified by the environment variable - ``$LINKAHEAD_CLIENT_CONFIGURATION``. -2. ``$PWD/caosdb_client.json`` -3. ``$PWD/caosdb-client.json`` -4. ``$PWD/.caosdb_client.json`` -5. ``$PWD/.caosdb-client.json`` -6. ``$HOME/caosdb_client.json`` -7. ``$HOME/caosdb-client.json`` -8. ``$HOME/.caosdb_client.json`` -9. ``$HOME/.caosdb-client.json`` +1. A file specified by the environment variable ``$LINKAHEAD_CLIENT_CONFIGURATION``. +2. ``$PWD/linkahead_client.json`` +3. ``$PWD/linkahead-client.json`` +4. ``$PWD/.linkahead_client.json`` +5. ``$PWD/.linkahead-client.json`` +6. ``$HOME/linkahead_client.json`` +7. ``$HOME/linkahead-client.json`` +8. ``$HOME/.linkahead_client.json`` +9. ``$HOME/.linkahead-client.json`` +10. A file specified by the environment variable ``$CAOSDB_CLIENT_CONFIGURATION``. +11. ``$PWD/caosdb_client.json`` +12. ``$PWD/caosdb-client.json`` +13. ``$PWD/.caosdb_client.json`` +14. ``$PWD/.caosdb-client.json`` +15. ``$HOME/caosdb_client.json`` +16. ``$HOME/caosdb-client.json`` +17. ``$HOME/.caosdb_client.json`` +18. ``$HOME/.caosdb-client.json`` Develop ------- diff --git a/doc/cppapi/index.rst.in b/doc/cppapi/index.rst.in index 57c9eb5..85d0fe5 100644 --- a/doc/cppapi/index.rst.in +++ b/doc/cppapi/index.rst.in @@ -25,7 +25,7 @@ C++ API ========= -This is the C++ library for connecting to CaosDB. If you are interested in code examples, please +This is the C++ library for connecting to LinkAhead. If you are interested in code examples, please refer to the corresponding :doc:`documentation section<examples.rst>`. -- GitLab