refs #93 documentation for sphinx-intl comman-line options (#94)

Author: shimizukawa

doc/conf.py

@@ -13,11 +13,12 @@
 # -- General configuration ---------------------------------------------------
 
 extensions = [
+    "sphinx_click",
 ]
 
 source_suffix = '.rst'
 master_doc = 'index'
-language = None
+language = 'en'
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 pygments_style = 'sphinx'
 

doc/refs.rst

@@ -10,12 +10,16 @@ Commands
 
 Type `sphinx-intl` without arguments, options to show command help.
 
+.. click:: sphinx_intl.commands:main
+   :prog: sphinx-intl
+   :nested: full
+
 
 Environment Variables
 =====================
 
 All command-line options can be set with environment variables using the
-format SPHINXINTL_<UPPER_LONG_NAME> . Dashes (-) have to be replaced with
+format ``SPHINXINTL_<UPPER_LONG_NAME>``. Dashes (-) have to be replaced with
 underscores (_).
 
 For example, to set the languages::

doc/requirements.txt

@@ -1,2 +1,3 @@
 sphinx
 sphinx_rtd_theme
+sphinx-click

sphinx_intl/commands.py

@@ -162,20 +162,6 @@ def convert(self, value, param, ctx):
 @option_tag
 @click.pass_context
 def main(ctx, config, tag):
-    """
-    Environment Variables:
-    All command-line options can be set with environment variables using the
-    format SPHINXINTL_<UPPER_LONG_NAME> . Dashes (-) have to replaced with
-        underscores (_).
-
-    For example, to set the languages:
-
-    export SPHINXINTL_LANGUAGE=de,ja
-
-    This is the same as passing the option to txutil directly:
-
-    sphinx-intl update --language=de --language=ja
-    """
     # load conf.py
     ctx.config = config
     if ctx.config is None: