kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 23:00:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove wrong usage of :option:

Browse Source 
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.
This commit is contained in:
Marijn van der Zee
2017-03-11 15:18:48 +01:00
parent 873b21fe0b
commit 2f9028969c
4 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/dev/virtualenvs.rst
+1 -1
View File
@@ -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.]