Skip to content

Commit

Permalink
docs: move python and cli reference to separate pages
Browse files Browse the repository at this point in the history
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).
  • Loading branch information
mslw committed Oct 9, 2023
1 parent 81dcfe5 commit e3607da
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 7 deletions.
7 changes: 7 additions & 0 deletions docs/source/cli_reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Command line reference
======================

.. toctree::
:maxdepth: 1

generated/man/datalad-hello-cmd
12 changes: 5 additions & 7 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
==================
Expand Down
8 changes: 8 additions & 0 deletions docs/source/python_reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
High-level API commands
=======================

.. currentmodule:: datalad.api
.. autosummary::
:toctree: generated

hello_cmd

0 comments on commit e3607da

Please sign in to comment.