Skip to content

Commit

Permalink
Generate ddev cli docs automatically (#6094)
Browse files Browse the repository at this point in the history
* Generate ddev cli docs automatically

* Use github version directly

* Use new plugin format
  • Loading branch information
FlorianVeaux authored and ofek committed May 2, 2020
1 parent 52ada97 commit b693478
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 4 deletions.
8 changes: 4 additions & 4 deletions docs/developer/ddev/cli.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# CLI

-----

::: mkdocs-click
:module: datadog_checks.dev.tooling.cli
:command: ddev
:depth: 0

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ markdown_extensions:
toc_depth: "2-6"
# Extra
- mkautodoc:
- mkdocs-click:
- pymdownx.arithmatex:
- pymdownx.betterem:
smart_enable: all
Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,6 @@ deps =
Pygments>=2.5.2
; for API auto-documentation
-e./datadog_checks_base[deps,http]
git+https://github.com/DataDog/mkdocs-click.git
commands =
python -m mkdocs {posargs}

0 comments on commit b693478

Please sign in to comment.