Skip to content

Commit ba594e6

Browse files
adamtheturtlestephenfin
authored andcommitted
Use unique identifiers for envvars
Add unique identifier for documented environment variables and remove them from the index. Fixes: #26
1 parent f4923d2 commit ba594e6

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

sphinx_click/ext.py

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,7 @@ def _format_arguments(ctx):
140140
def _format_envvar(param):
141141
"""Format the envvars of a `click.Option` or `click.Argument`."""
142142
yield '.. envvar:: {}'.format(param.envvar)
143+
yield ' :noindex:'
143144
yield ''
144145
if isinstance(param, click.Argument):
145146
param_ref = param.human_readable_name
@@ -156,6 +157,12 @@ def _format_envvars(ctx):
156157
params = [x for x in ctx.command.params if getattr(x, 'envvar')]
157158

158159
for param in params:
160+
yield '.. _{command_name}-{param_name}-{envvar}:'.format(
161+
command_name=ctx.command.name,
162+
param_name=param.name,
163+
envvar=param.envvar,
164+
)
165+
yield ''
159166
for line in _format_envvar(param):
160167
yield line
161168
yield ''

tests/test_formatter.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,11 +71,17 @@ def cli():
7171
7272
.. rubric:: Environment variables
7373
74+
.. _cli-param-PARAM:
75+
7476
.. envvar:: PARAM
77+
:noindex:
7578
7679
Provide a default for :option:`--param`
7780
81+
.. _cli-arg-ARG:
82+
7883
.. envvar:: ARG
84+
:noindex:
7985
8086
Provide a default for :option:`ARG`
8187
""").lstrip(), '\n'.join(output))

0 commit comments

Comments
 (0)