diff options
author | Martin Panter <vadmium+py@gmail.com> | 2016-10-30 04:20:17 (GMT) |
---|---|---|
committer | Martin Panter <vadmium+py@gmail.com> | 2016-10-30 04:20:17 (GMT) |
commit | 5c6793394066b012b9674681b0815667938ce4d9 (patch) | |
tree | d509384329f92ba096f11629e3e46cc575822d61 /Doc/distutils/configfile.rst | |
parent | 62fe1bb983084c74fd8e7028412d0130a14568f3 (diff) | |
download | cpython-5c6793394066b012b9674681b0815667938ce4d9.zip cpython-5c6793394066b012b9674681b0815667938ce4d9.tar.gz cpython-5c6793394066b012b9674681b0815667938ce4d9.tar.bz2 |
Issue #26638: Mask undefined CLI options to defeat new Sphinx warnings
Diffstat (limited to 'Doc/distutils/configfile.rst')
-rw-r--r-- | Doc/distutils/configfile.rst | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/Doc/distutils/configfile.rst b/Doc/distutils/configfile.rst index 51d8897..21f1acd 100644 --- a/Doc/distutils/configfile.rst +++ b/Doc/distutils/configfile.rst @@ -66,7 +66,7 @@ universal :option:`!--help` option, e.g. :: --swig-opts list of SWIG command line options [...] -Note that an option spelled :option:`--foo-bar` on the command-line is spelled +Note that an option spelled :option:`!--foo-bar` on the command-line is spelled ``foo_bar`` in configuration files. .. _distutils-build-ext-inplace: @@ -75,12 +75,12 @@ For example, say you want your extensions to be built "in-place"---that is, you have an extension :mod:`pkg.ext`, and you want the compiled extension file (:file:`ext.so` on Unix, say) to be put in the same source directory as your pure Python modules :mod:`pkg.mod1` and :mod:`pkg.mod2`. You can always use the -:option:`--inplace` option on the command-line to ensure this:: +:option:`!--inplace` option on the command-line to ensure this:: python setup.py build_ext --inplace But this requires that you always specify the :command:`build_ext` command -explicitly, and remember to provide :option:`--inplace`. An easier way is to +explicitly, and remember to provide :option:`!--inplace`. An easier way is to "set and forget" this option, by encoding it in :file:`setup.cfg`, the configuration file for this distribution:: |