Commit 2f90289
committed
Remove wrong usage of :option:
From http://www.sphinx-doc.org/en/stable/domains.html#directive-option:
> The directive will create cross-reference targets for the given options,
> referencable by option (in the example case, you’d use something like
> :option:`dest_dir`, :option:`-m`, or :option:`--module`).
I don't think we're intending here to create cross references,
we simply want to render it nicely.
So just use code formatting instead.
This gets rid of the last build warnings.1 parent 873b21f commit 2f90289
4 files changed
Lines changed: 4 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -38,7 +38,7 @@ over the syntax file included in Vim 6.1. | |||
| 38 | 38 | These plugins supply you with a basic environment for developing in Python. | |
| 39 | 39 | To get the most out of Vim, you should continually check your code for syntax | |
| 40 | 40 | errors and PEP8 compliance. Luckily PEP8_ and Pyflakes_ will do this for you. | |
| 41 | - If your Vim is compiled with :option:`+python` you can also utilize some very | ||
| 41 | + If your Vim is compiled with ``+python`` you can also utilize some very | ||
| 42 | 42 | handy plugins to do these checks from within the editor. | |
| 43 | 43 | ||
| 44 | 44 | For PEP8 checking and pyflakes, you can install vim-flake8_. Now you can map the | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -93,7 +93,7 @@ where they were placed. | |||
| 93 | 93 | Other Notes | |
| 94 | 94 | ~~~~~~~~~~~ | |
| 95 | 95 | ||
| 96 | - Running ``virtualenv`` with the option :option:`--no-site-packages` will not | ||
| 96 | + Running ``virtualenv`` with the option ``--no-site-packages`` will not | ||
| 97 | 97 | include the packages that are installed globally. This can be useful | |
| 98 | 98 | for keeping the package list clean in case it needs to be accessed later. | |
| 99 | 99 | [This is the default behavior for ``virtualenv`` 1.7 and later.] | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -60,7 +60,7 @@ py2app no no yes yes MIT no yes yes | |||
| 60 | 60 | .. note:: | |
| 61 | 61 | All solutions need MS Visual C++ dll to be installed on target machine, except py2app. | |
| 62 | 62 | Only Pyinstaller makes self-executable exe that bundles the dll when | |
| 63 | - passing :option:`--onefile` to :file:`Configure.py`. | ||
| 63 | + passing ``--onefile`` to :file:`Configure.py`. | ||
| 64 | 64 | ||
| 65 | 65 | Windows | |
| 66 | 66 | ------- | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -101,7 +101,7 @@ pypiserver | |||
| 101 | 101 | `Pypiserver <https://pypi.python.org/pypi/pypiserver>`_ is a minimal PyPI | |
| 102 | 102 | compatible server. It can be used to serve a set of packages to easy_install | |
| 103 | 103 | or pip. It includes helpful features like an administrative command | |
| 104 | - (:option:`-U`) which will update all its packages to their latest versions | ||
| 104 | + (``-U``) which will update all its packages to their latest versions | ||
| 105 | 105 | found on PyPI. | |
| 106 | 106 | ||
| 107 | 107 | ||
0 commit comments