From 2f9028969c5232a8e2738ee5080246e2cc901f6d Mon Sep 17 00:00:00 2001 From: Marijn van der Zee Date: Sat, 11 Mar 2017 15:18:48 +0100 Subject: [PATCH] Remove wrong usage of :option: MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- docs/dev/env.rst | 2 +- docs/dev/virtualenvs.rst | 2 +- docs/shipping/freezing.rst | 2 +- docs/shipping/packaging.rst | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/dev/env.rst b/docs/dev/env.rst index 59500ff..3330fb6 100644 --- a/docs/dev/env.rst +++ b/docs/dev/env.rst @@ -38,7 +38,7 @@ over the syntax file included in Vim 6.1. These plugins supply you with a basic environment for developing in Python. To get the most out of Vim, you should continually check your code for syntax errors and PEP8 compliance. Luckily PEP8_ and Pyflakes_ will do this for you. -If your Vim is compiled with :option:`+python` you can also utilize some very +If your Vim is compiled with ``+python`` you can also utilize some very handy plugins to do these checks from within the editor. For PEP8 checking and pyflakes, you can install vim-flake8_. Now you can map the diff --git a/docs/dev/virtualenvs.rst b/docs/dev/virtualenvs.rst index 77773f6..99b21db 100644 --- a/docs/dev/virtualenvs.rst +++ b/docs/dev/virtualenvs.rst @@ -93,7 +93,7 @@ where they were placed. Other Notes ~~~~~~~~~~~ -Running ``virtualenv`` with the option :option:`--no-site-packages` will not +Running ``virtualenv`` with the option ``--no-site-packages`` will not include the packages that are installed globally. This can be useful for keeping the package list clean in case it needs to be accessed later. [This is the default behavior for ``virtualenv`` 1.7 and later.] diff --git a/docs/shipping/freezing.rst b/docs/shipping/freezing.rst index 4e2de50..b75d0c1 100644 --- a/docs/shipping/freezing.rst +++ b/docs/shipping/freezing.rst @@ -60,7 +60,7 @@ py2app no no yes yes MIT no yes yes .. note:: All solutions need MS Visual C++ dll to be installed on target machine, except py2app. Only Pyinstaller makes self-executable exe that bundles the dll when - passing :option:`--onefile` to :file:`Configure.py`. + passing ``--onefile`` to :file:`Configure.py`. Windows ------- diff --git a/docs/shipping/packaging.rst b/docs/shipping/packaging.rst index c679575..8100ee3 100644 --- a/docs/shipping/packaging.rst +++ b/docs/shipping/packaging.rst @@ -101,7 +101,7 @@ pypiserver `Pypiserver `_ is a minimal PyPI compatible server. It can be used to serve a set of packages to easy_install or pip. It includes helpful features like an administrative command -(:option:`-U`) which will update all its packages to their latest versions +(``-U``) which will update all its packages to their latest versions found on PyPI.