Skip to content

Commit a95a9a5

Browse files
committed
Revert "#93 documentation for sphinx-intl comman-line options"
This reverts commit 8a4fd64.
1 parent 8a4fd64 commit a95a9a5

File tree

4 files changed

+16
-8
lines changed

4 files changed

+16
-8
lines changed

doc/conf.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,11 @@
1313
# -- General configuration ---------------------------------------------------
1414

1515
extensions = [
16-
"sphinx_click",
1716
]
1817

1918
source_suffix = '.rst'
2019
master_doc = 'index'
21-
language = 'en'
20+
language = None
2221
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
2322
pygments_style = 'sphinx'
2423

doc/refs.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,12 @@ Commands
1010

1111
Type `sphinx-intl` without arguments, options to show command help.
1212

13-
.. click:: sphinx_intl.commands:main
14-
:prog: sphinx-intl
15-
:nested: full
16-
1713

1814
Environment Variables
1915
=====================
2016

2117
All command-line options can be set with environment variables using the
22-
format ``SPHINXINTL_<UPPER_LONG_NAME>``. Dashes (-) have to be replaced with
18+
format SPHINXINTL_<UPPER_LONG_NAME> . Dashes (-) have to be replaced with
2319
underscores (_).
2420

2521
For example, to set the languages::

doc/requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,2 @@
11
sphinx
22
sphinx_rtd_theme
3-
sphinx-click

sphinx_intl/commands.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,20 @@ def convert(self, value, param, ctx):
162162
@option_tag
163163
@click.pass_context
164164
def main(ctx, config, tag):
165+
"""
166+
Environment Variables:
167+
All command-line options can be set with environment variables using the
168+
format SPHINXINTL_<UPPER_LONG_NAME> . Dashes (-) have to replaced with
169+
underscores (_).
170+
171+
For example, to set the languages:
172+
173+
export SPHINXINTL_LANGUAGE=de,ja
174+
175+
This is the same as passing the option to txutil directly:
176+
177+
sphinx-intl update --language=de --language=ja
178+
"""
165179
# load conf.py
166180
ctx.config = config
167181
if ctx.config is None:

0 commit comments

Comments
 (0)