summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorshimizukawa <shimizukawa@gmail.com>2018-03-16 16:19:39 +0900
committershimizukawa <shimizukawa@gmail.com>2018-03-16 16:19:39 +0900
commite3470bbde33bff93c363d86f7a2ad0380faecd07 (patch)
tree98b9526422a5b63e85b6c8d96127a3f1ea8415f2
parentbccdc7f02d1ee89212651f577551bc41e608ce02 (diff)
downloadsphinx-git-e3470bbde33bff93c363d86f7a2ad0380faecd07.tar.gz
fix #4734: Describe how to specify make.bat parameter on Windows
-rw-r--r--doc/intl.rst19
1 files changed, 17 insertions, 2 deletions
diff --git a/doc/intl.rst b/doc/intl.rst
index dacced65b..870d06240 100644
--- a/doc/intl.rst
+++ b/doc/intl.rst
@@ -113,12 +113,27 @@ This section describe an easy way to translate with sphinx-intl.
#. make translated document.
You need a :confval:`language` parameter in ``conf.py`` or you may also
- specify the parameter on the command line:
+ specify the parameter on the command line (for BSD/GNU make):
.. code-block:: console
$ make -e SPHINXOPTS="-D language='de'" html
+ command line (for Windows cmd.exe):
+
+ .. code-block:: console
+
+ > set SPHINXOPTS=-D language='de'
+ > .\make.bat html
+
+ command line (for PowerShell):
+
+ .. code-block:: console
+
+ > Set-Item env:SPHINXOPTS "-D language='de'"
+ > .\make.bat html
+
+
Congratulations! You got the translated documentation in the ``_build/html``
directory.
@@ -263,7 +278,7 @@ easy to fetch and push translations.
...
Done.
- Invoke make html:
+ Invoke make html (for BSD/GNU make):
.. code-block:: console