docs: add reference level in navigation (#80)

Fixes #79
afuetterer · May 26, 2024 · 6a41547 · 6a41547
1 parent f3eef8b
commit 6a41547
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 4 deletions.
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
@@ -15,8 +15,9 @@ watch:
 
 nav:
 - Home: index.md
-- API Reference: api.md
-- CLI Reference: cli.md
+- Reference:
+  - API Reference: api.md
+  - Command Line Interface: cli.md
 - Meta:
   - Contributor Guide: contributing.md
   - Changelog: changelog.md

diff --git a/docs/src/cli.md b/docs/src/cli.md
@@ -1,4 +1,4 @@
-# CLI Reference
+# Command Line Interface
 
 python-re3data.
 
@@ -14,3 +14,56 @@ $ re3data [OPTIONS] COMMAND [ARGS]...
 * `--install-completion`: Install completion for the current shell.
 * `--show-completion`: Show completion for the current shell, to copy it or customize the installation.
 * `--help`: Show this message and exit.
+
+**Commands**:
+
+* `repository`
+
+## `re3data repository`
+
+**Usage**:
+
+```console
+$ re3data repository [OPTIONS] COMMAND [ARGS]...
+```
+
+**Options**:
+
+* `--help`: Show this message and exit.
+
+**Commands**:
+
+* `get`: Get the metadata of a specific repository.
+* `list`: List the metadata of all repositories in...
+
+### `re3data repository get`
+
+Get the metadata of a specific repository.
+
+**Usage**:
+
+```console
+$ re3data repository get [OPTIONS] REPOSITORY_ID
+```
+
+**Arguments**:
+
+* `REPOSITORY_ID`: [required]
+
+**Options**:
+
+* `--help`: Show this message and exit.
+
+### `re3data repository list`
+
+List the metadata of all repositories in the re3data API.
+
+**Usage**:
+
+```console
+$ re3data repository list [OPTIONS]
+```
+
+**Options**:
+
+* `--help`: Show this message and exit.
diff --git a/pyproject.toml b/pyproject.toml
@@ -129,7 +129,7 @@ pip-compile-resolver = "uv"
 lock-filename = "requirements/{env_name}.txt"
 
 [tool.hatch.envs.docs.scripts]
-cli = "typer src/re3data/_cli.py utils docs --name=re3data --title='CLI Reference' --output docs/src/cli.md"
+cli = "typer src/re3data/_cli.py utils docs --name=re3data --title='Command Line Interface' --output docs/src/cli.md"
 build = "mkdocs build --config-file=docs/mkdocs.yml"
 serve = "mkdocs serve --verbose --config-file=docs/mkdocs.yml"
 deploy = "mike deploy --push --update-aliases $(hatch version) latest --config-file=docs/mkdocs.yml"