Skip to content

Commit e54db83

Browse files
authored
Chore/click autodoc (#118)
* implement @quiet_sdk_options * add sphinx_click * update command docs to use sphinx-click * remove a test thing * add sphinx-click to tox.ini * use the right module name * tox style fixes * add doc requirements for readthedocs * rework quiet_sdk_option into a flag instead of separate decorator
1 parent 2632b74 commit e54db83

24 files changed

+107
-514
lines changed

docs/commands.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Commands
22

3-
* [Profile](commands/profile.md)
4-
* [Security Data](commands/securitydata.md)
5-
* [Alerts](commands/alerts.md)
6-
* [Alert Rules](commands/alertrules.md)
7-
* [Departing Employee](commands/departingemployee.md)
8-
* [High Risk Employee](commands/highriskemployee.md)
3+
* [Profile](commands/profile.rst)
4+
* [Security Data](commands/securitydata.rst)
5+
* [Alerts](commands/alerts.rst)
6+
* [Alert Rules](commands/alertrules.rst)
7+
* [Departing Employee](commands/departingemployee.rst)
8+
* [High Risk Employee](commands/highriskemployee.rst)

docs/commands/alertrules.md

Lines changed: 0 additions & 84 deletions
This file was deleted.

docs/commands/alertrules.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. click:: code42cli.cmds.alert_rules:alert_rules
2+
:prog: alert-rules
3+
:show-nested:

docs/commands/alerts.md

Lines changed: 0 additions & 51 deletions
This file was deleted.

docs/commands/alerts.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. click:: code42cli.cmds.alerts:alerts
2+
:prog: alerts
3+
:show-nested:

docs/commands/departingemployee.md

Lines changed: 0 additions & 65 deletions
This file was deleted.
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. click:: code42cli.cmds.departing_employee:departing_employee
2+
:prog: departing-employee
3+
:show-nested:

docs/commands/highriskemployee.md

Lines changed: 0 additions & 97 deletions
This file was deleted.

docs/commands/highriskemployee.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.. click:: code42cli.cmds.high_risk_employee:high_risk_employee
2+
:prog: high-risk-employee
3+
:show-nested:

0 commit comments

Comments
 (0)