docs: Restructure Python package docs

- This enables "Section Navigation" - Each module has it's own .rst file with a "main section headline", - and is bound together by a "subindex" defined by index_discogs_client.rst
joalla · Oct 23, 2024 · 44dce6d · 44dce6d
1 parent 3c9737f
commit 44dce6d
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 28 deletions.
diff --git a/docs/source/discogs_client.client.rst b/docs/source/discogs_client.client.rst
@@ -0,0 +1,4 @@
+discogs\_client.client module
+=============================
+
+.. automodule:: discogs_client.client
diff --git a/docs/source/discogs_client.exceptions.rst b/docs/source/discogs_client.exceptions.rst
@@ -0,0 +1,5 @@
+discogs\_client.exceptions module
+=================================
+
+.. automodule:: discogs_client.exceptions
+
diff --git a/docs/source/discogs_client.fetchers.rst b/docs/source/discogs_client.fetchers.rst
@@ -0,0 +1,5 @@
+discogs\_client.fetchers module
+===============================
+
+.. automodule:: discogs_client.fetchers
+
diff --git a/docs/source/discogs_client.models.rst b/docs/source/discogs_client.models.rst
@@ -0,0 +1,5 @@
+discogs\_client.models module
+=============================
+
+.. automodule:: discogs_client.models
+
diff --git a/docs/source/discogs_client.rst b/docs/source/discogs_client.rst
diff --git a/docs/source/discogs_client.utils.rst b/docs/source/discogs_client.utils.rst
@@ -0,0 +1,5 @@
+discogs\_client.utils module
+============================
+
+.. automodule:: discogs_client.utils
+
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -19,7 +19,7 @@ python3-discogs-client documentation
    optional_configuration.md
    contributing.md
    writing_docs.md
-   discogs_client
+   index_discogs_client
 
 
 Indices and tables

diff --git a/docs/source/index_discogs_client.rst b/docs/source/index_discogs_client.rst
@@ -0,0 +1,13 @@
+discogs_client package
+======================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   discogs_client.client
+   discogs_client.exceptions
+   discogs_client.fetchers
+   discogs_client.models
+   discogs_client.utils
+