From e3607da76333629dc57d5269a45f1832b9efe9fe Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Szczepanik?= Date: Mon, 9 Oct 2023 17:25:45 +0200 Subject: [PATCH] docs: move python and cli reference to separate pages This helps tidy up the home page (only lists of commands, no table) and navigation bar (proper sections for High-level API commands and Command line reference). --- docs/source/cli_reference.rst | 7 +++++++ docs/source/index.rst | 12 +++++------- docs/source/python_reference.rst | 8 ++++++++ 3 files changed, 20 insertions(+), 7 deletions(-) create mode 100644 docs/source/cli_reference.rst create mode 100644 docs/source/python_reference.rst diff --git a/docs/source/cli_reference.rst b/docs/source/cli_reference.rst new file mode 100644 index 00000000..534bb72a --- /dev/null +++ b/docs/source/cli_reference.rst @@ -0,0 +1,7 @@ +Command line reference +====================== + +.. toctree:: + :maxdepth: 1 + + generated/man/datalad-hello-cmd diff --git a/docs/source/index.rst b/docs/source/index.rst index ce2fdb3d..98912e03 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -11,21 +11,19 @@ API High-level API commands ----------------------- -.. currentmodule:: datalad.api -.. autosummary:: - :toctree: generated +.. toctree:: + :maxdepth: 2 - hello_cmd + python_reference.rst Command line reference ---------------------- .. toctree:: - :maxdepth: 1 - - generated/man/datalad-hello-cmd + :maxdepth: 2 + cli_reference.rst Indices and tables ================== diff --git a/docs/source/python_reference.rst b/docs/source/python_reference.rst new file mode 100644 index 00000000..0b143c6a --- /dev/null +++ b/docs/source/python_reference.rst @@ -0,0 +1,8 @@ +High-level API commands +======================= + +.. currentmodule:: datalad.api +.. autosummary:: + :toctree: generated + + hello_cmd