From 72133fefa9957ff579801925cfdfc5b7963c3413 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Henrik=20tom=20W=C3=B6rden?= <henrik@trineo.org>
Date: Thu, 17 Dec 2020 15:49:54 +0100
Subject: [PATCH] DOC: unify the name PyCaosDB
---
README_SETUP.md | 8 ++++----
src/doc/concepts.rst | 2 +-
src/doc/configuration.md | 6 +++---
src/doc/index.rst | 4 ++--
4 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/README_SETUP.md b/README_SETUP.md
index 7f2fbdd7..481182d0 100644
--- a/README_SETUP.md
+++ b/README_SETUP.md
@@ -1,10 +1,10 @@
-# Getting started with pycaosdb #
+# Getting started with PyCaosDB #
## Installation ##
### Requirements ###
-Pycaosdb needs at least Python 3.6. Additionally, the following packages are required (they will
+PyCaosDB needs at least Python 3.6. Additionally, the following packages are required (they will
typically be installed automatically):
- `lxml`
@@ -32,7 +32,7 @@ installation](#generic-installation) section.
#### Generic installation ####
-To install pycaosdb locally, use `pip3` (also called `pip` on some systems):
+To install PyCaosDB locally, use `pip3` (also called `pip` on some systems):
```sh
pip3 install --user caosdb
@@ -52,7 +52,7 @@ pip3 install --user .
## Configuration ##
The configuration is done using `ini` configuration files.
-Pycaosdb tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
+PyCaosDB tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
alternatively in `~/.pycaosdb.ini` upon import. After that, the ini file `pycaosdb.ini` in the
current working directory will be read additionally, if it exists.
diff --git a/src/doc/concepts.rst b/src/doc/concepts.rst
index fb7f3a62..29625a0a 100644
--- a/src/doc/concepts.rst
+++ b/src/doc/concepts.rst
@@ -1,5 +1,5 @@
========================
-The concepts of pycaosdb
+The concepts of PyCaosDB
========================
- `Configuration <configuration>`
diff --git a/src/doc/configuration.md b/src/doc/configuration.md
index 4acfb323..b2de2781 100644
--- a/src/doc/configuration.md
+++ b/src/doc/configuration.md
@@ -1,6 +1,6 @@
-# Configuration of pycaosdb #
-The behavior of pycaosdb is defined via a configuration that is provided using configuration files.
-Pycaosdb tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
+# Configuration of PyCaosDB #
+The behavior of PyCaosDB is defined via a configuration that is provided using configuration files.
+PyCaosDB tries to read from the inifile specified in the environment variable `PYCAOSDBINI` or
alternatively in `~/.pycaosdb.ini` upon import. After that, the ini file `pycaosdb.ini` in the
current working directory will be read additionally, if it exists.
diff --git a/src/doc/index.rst b/src/doc/index.rst
index c56d2f13..e8cc93aa 100644
--- a/src/doc/index.rst
+++ b/src/doc/index.rst
@@ -1,5 +1,5 @@
-Welcome to pycaosdb's documentation!
+Welcome to PyCaosDB's documentation!
====================================
.. toctree::
@@ -13,7 +13,7 @@ Welcome to pycaosdb's documentation!
Configuration <configuration>
API documentation<_apidoc/modules>
-This is the documentation for the Python client library for CaosDB, ``pycaosdb``.
+This is the documentation for the Python client library for CaosDB, ``PyCaosDB``.
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>`.
--
GitLab