From 27b4b73db1de2cf076b3de62cae4da6636992ad1 Mon Sep 17 00:00:00 2001 From: Johannes Tiefenbacher Date: Sun, 13 Oct 2024 15:54:17 +0200 Subject: [PATCH] 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 --- docs/source/discogs_client.client.rst | 4 ++++ docs/source/discogs_client.exceptions.rst | 5 +++++ docs/source/discogs_client.fetchers.rst | 5 +++++ docs/source/discogs_client.models.rst | 5 +++++ docs/source/discogs_client.utils.rst | 5 +++++ docs/source/index.rst | 2 +- docs/source/index_discogs_client.rst | 13 +++++++++++++ 7 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 docs/source/discogs_client.client.rst create mode 100644 docs/source/discogs_client.exceptions.rst create mode 100644 docs/source/discogs_client.fetchers.rst create mode 100644 docs/source/discogs_client.models.rst create mode 100644 docs/source/discogs_client.utils.rst create mode 100644 docs/source/index_discogs_client.rst diff --git a/docs/source/discogs_client.client.rst b/docs/source/discogs_client.client.rst new file mode 100644 index 0000000..a3ddeb4 --- /dev/null +++ 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 new file mode 100644 index 0000000..c1856b9 --- /dev/null +++ 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 new file mode 100644 index 0000000..e4f7aa3 --- /dev/null +++ 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 new file mode 100644 index 0000000..723c276 --- /dev/null +++ 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.utils.rst b/docs/source/discogs_client.utils.rst new file mode 100644 index 0000000..61ea23d --- /dev/null +++ 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 index bcbf49b..9c4e028 100644 --- 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 new file mode 100644 index 0000000..e91144e --- /dev/null +++ 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 +