From b298ed84a77c4f1ae0e3adeab4e02e06b1243f79 Mon Sep 17 00:00:00 2001 From: Alex Carney Date: Thu, 21 Dec 2023 17:11:28 +0000 Subject: [PATCH] docs: add API Reference section Nothing new just yet, just making what already exists more prominant --- docs/source/index.rst | 8 ++++++-- docs/source/{pages => }/reference.rst | 2 +- docs/source/{pages => }/reference/clients.rst | 0 docs/source/{pages => }/reference/protocol.rst | 0 docs/source/{pages => }/reference/servers.rst | 0 docs/source/{pages => }/reference/types.rst | 0 docs/source/{pages => }/reference/workspace.rst | 0 7 files changed, 7 insertions(+), 3 deletions(-) rename docs/source/{pages => }/reference.rst (80%) rename docs/source/{pages => }/reference/clients.rst (100%) rename docs/source/{pages => }/reference/protocol.rst (100%) rename docs/source/{pages => }/reference/servers.rst (100%) rename docs/source/{pages => }/reference/types.rst (100%) rename docs/source/{pages => }/reference/workspace.rst (100%) diff --git a/docs/source/index.rst b/docs/source/index.rst index 0069cee4..3fba7b6f 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -41,8 +41,6 @@ User Guide pages/tutorial pages/user-guide pages/testing - pages/reference - .. toctree:: :hidden: @@ -51,6 +49,12 @@ User Guide Handle Invalid Data Migrate to v1 +.. toctree:: + :hidden: + :glob: + :caption: API Reference + + reference/* .. toctree:: :hidden: diff --git a/docs/source/pages/reference.rst b/docs/source/reference.rst similarity index 80% rename from docs/source/pages/reference.rst rename to docs/source/reference.rst index 2b0aa56b..04312347 100644 --- a/docs/source/pages/reference.rst +++ b/docs/source/reference.rst @@ -2,7 +2,7 @@ API Reference ============= .. toctree:: + :maxdepth: 1 :glob: - :maxdepth: 2 reference/* diff --git a/docs/source/pages/reference/clients.rst b/docs/source/reference/clients.rst similarity index 100% rename from docs/source/pages/reference/clients.rst rename to docs/source/reference/clients.rst diff --git a/docs/source/pages/reference/protocol.rst b/docs/source/reference/protocol.rst similarity index 100% rename from docs/source/pages/reference/protocol.rst rename to docs/source/reference/protocol.rst diff --git a/docs/source/pages/reference/servers.rst b/docs/source/reference/servers.rst similarity index 100% rename from docs/source/pages/reference/servers.rst rename to docs/source/reference/servers.rst diff --git a/docs/source/pages/reference/types.rst b/docs/source/reference/types.rst similarity index 100% rename from docs/source/pages/reference/types.rst rename to docs/source/reference/types.rst diff --git a/docs/source/pages/reference/workspace.rst b/docs/source/reference/workspace.rst similarity index 100% rename from docs/source/pages/reference/workspace.rst rename to docs/source/reference/workspace.rst