From 5776b2f6f1ff20e200593728868f54c105b3e4a3 Mon Sep 17 00:00:00 2001 From: yangliwei Date: Sat, 2 Mar 2024 00:19:10 +0800 Subject: [PATCH] Add the toctree for the generated API --- docs/source/api-reference/modules.rst | 12 ++++++++++++ docs/source/index.rst | 7 +++++++ 2 files changed, 19 insertions(+) create mode 100644 docs/source/api-reference/modules.rst diff --git a/docs/source/api-reference/modules.rst b/docs/source/api-reference/modules.rst new file mode 100644 index 0000000..cf7a9af --- /dev/null +++ b/docs/source/api-reference/modules.rst @@ -0,0 +1,12 @@ +.. _Components: + +API reference +============= + +In this section we present the main qibotn components and primitives included in the public API. + + +.. toctree:: + :maxdepth: 3 + + qibotn diff --git a/docs/source/index.rst b/docs/source/index.rst index 9f96e54..08fb666 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -49,6 +49,13 @@ Contents Installation Quickstart +.. toctree:: + :maxdepth: 2 + :caption: Main documentation + + api-reference/modules + Developer guides + .. toctree:: :maxdepth: 1 :caption: Documentation links