@@ -59,13 +59,6 @@ Once enabled, *sphinx-click* enables automatic documentation for
59
59
their options and their environment variables using the `Sphinx standard
60
60
domain `_.
61
61
62
- *sphinx-click * allows for modules to be mocked out using the same method used by
63
- `sphinx.ext.autodoc `_. Modules to mock while the documentation is being built
64
- can be specified using the ``sphinx_click_mock_imports `` config value, if specified.
65
- Otherwise the value of ``autodoc_mock_imports `` is used, following the behavior
66
- of ``sphinx.ext.autosummary ``. The value of this config option should be a list
67
- of module names; see `sphinx.ext.autodoc `_ for more information.
68
-
69
62
.. _cross-referencing :
70
63
71
64
Cross-referencing
@@ -97,9 +90,22 @@ Programs
97
90
98
91
__ https://github.com/sphinx-doc/sphinx/issues/880
99
92
93
+ .. _mocking :
100
94
101
- Docstring processing
102
- --------------------
95
+ Mocking
96
+ -------
97
+
98
+ *sphinx-click * allows for modules to be mocked out using the same method used by
99
+ `sphinx.ext.autodoc `_. Modules to mock while the documentation is being built
100
+ can be specified using the ``sphinx_click_mock_imports `` config value, if specified.
101
+ Otherwise the value of ``autodoc_mock_imports `` is used, following the behavior
102
+ of ``sphinx.ext.autosummary ``. The value of this config option should be a list
103
+ of module names; see `sphinx.ext.autodoc `_ for more information.
104
+
105
+ .. _events :
106
+
107
+ Events
108
+ ------
103
109
104
110
*sphinx-click * provides the following additional events:
105
111
@@ -129,7 +135,6 @@ modify **in place** to change what Sphinx puts into the output.
129
135
def setup (app ):
130
136
app.connect(" sphinx-click-process-description" , process_description)
131
137
132
-
133
138
Example
134
139
-------
135
140
@@ -233,7 +238,6 @@ using *sphinx-click* and the following directive:
233
238
This will render the subcommands of each group in different sections, one for each
234
239
group in ``sources ``. An example is provided in :doc: `examples/commandcollections `.
235
240
236
-
237
241
Modifying ``sys.path ``
238
242
----------------------
239
243
0 commit comments