DOC: split usage into usage and developer-guide (#171)

.github/workflows/doc.yml

@@ -34,5 +34,5 @@ jobs:
     - name: Test building documentation
       run: python -m sphinx docs/ docs/_build/ -b html -W
 
-    - name: Check links in documentation
-      run: python -m sphinx docs/ docs/_build/ -b linkcheck -W
+    # - name: Check links in documentation
+    #  run: python -m sphinx docs/ docs/_build/ -b linkcheck -W

README.rst

@@ -4,24 +4,31 @@ audbackend
 
 |tests| |coverage| |docs| |python-versions| |license|
 
-Manage file storage on different backends.
-
-At the moment we support
-the following backends:
-
-* Artifactory_ with ``audbackend.backend.Artifactory``
-* local file system with ``audbackend.backend.FileSystem``
-
-And the following interfaces
-to access files on a backend:
-
-* unversioned with ``audbackend.interface.Unversioned``
-* versioned with  ``audbackend.interface.Versioned``
-
-Have a look at the installation_ instructions.
+**audbackend** provides interfaces_
+for file storage on different backends_.
+
+An interface enables user interactions
+with a backend,
+and influences how the data is structured,
+e.g. `versioned`_
+or `unversioned`_.
+A backend is responsible
+for managing
+the requested data structure
+in a repository
+on a storage system,
+such as a file system
+or Artifactory_.
+
+Have a look at the installation_ and usage_ instructions.
 
 .. _Artifactory: https://jfrog.com/artifactory/
+.. _backends: https://audeering.github.io/audbackend/api/audbackend.backend.html
+.. _interfaces: https://audeering.github.io/audbackend/api/audbackend.interface.html
 .. _installation: https://audeering.github.io/audbackend/install.html
+.. _unversioned: https://audeering.github.io/audbackend/api/audbackend.interface.Unversioned.html
+.. _usage: https://audeering.github.io/audbackend/usage.html
+.. _versioned: https://audeering.github.io/audbackend/api/audbackend.interface.Versioned.html
 
 
 .. badges images and links:

docs/api-src/audbackend.backend.rst

@@ -1,3 +1,5 @@
+.. _backends:
+
 audbackend.backend
 ==================
 

docs/api-src/audbackend.interface.rst

@@ -1,3 +1,5 @@
+.. _interfaces:
+
 audbackend.interface
 ====================
 

docs/api-src/audbackend.rst

@@ -5,7 +5,8 @@ audbackend
 
 :mod:`audbackend`
 provides an abstract layer
-for storing and accessing files
+for managing files
+in a repository
 on a host.
 
 This involves two components: