Skip to content

Commit 14faac3

Browse files
committed
Improve docs for "commands"
1 parent cfa2df6 commit 14faac3

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

doc-source/api/commands.rst

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616
.. class:: MarkdownHelpCommand
1717
MarkdownHelpGroup
1818

19+
Bases: :class:`~.MarkdownHelpMixin`
20+
1921
Subclasses of :class:`click.Command` and :class:`click.Group`
2022
which treat the help text as markdown and print a rendered representation.
2123

@@ -30,8 +32,21 @@
3032

3133
.. automethod:: MarkdownHelpCommand.parse_args
3234

35+
.. autoclass:: consolekit.commands.MarkdownHelpMixin
36+
:no-autosummary:
3337

34-
.. automodule:: consolekit.commands
35-
:exclude-members: ContextInheritingGroup,MarkdownHelpCommand,MarkdownHelpGroup
38+
.. class:: RawHelpCommand
39+
RawHelpGroup
40+
41+
Bases: :class:`~.RawHelpMixin`
42+
43+
Subclasses of :class:`click.Command` and :class:`click.Group`
44+
which leave the help text unformatted.
45+
46+
.. versionadded:: 0.8.0
47+
48+
.. autoclass:: consolekit.commands.RawHelpMixin
49+
:no-autosummary:
50+
51+
.. autoclass:: consolekit.commands.SuggestionGroup
3652
:no-autosummary:
37-
:no-docstring:

0 commit comments

Comments
 (0)