summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBernat Gabor <bgabor8@bloomberg.net>2018-10-25 15:01:11 +0100
committerBernat Gabor <bgabor8@bloomberg.net>2018-10-25 15:02:52 +0100
commitd1c68182628268e5b00a35c973d3322ae4dc9b00 (patch)
treeb2200aa099559c475790dd68f242b3e2fb8848f7 /docs
parent6974665f6eaea0d1effeab0b684e3841ced62629 (diff)
downloadvirtualenv-d1c68182628268e5b00a35c973d3322ae4dc9b00.tar.gz
fix readme, add lint params
Diffstat (limited to 'docs')
-rw-r--r--docs/changes.rst16
-rw-r--r--docs/conf.py70
-rw-r--r--docs/development.rst10
-rw-r--r--docs/installation.rst2
-rw-r--r--docs/userguide.rst3
5 files changed, 51 insertions, 50 deletions
diff --git a/docs/changes.rst b/docs/changes.rst
index 5b5bb4e..6b0bc00 100644
--- a/docs/changes.rst
+++ b/docs/changes.rst
@@ -75,7 +75,7 @@ Release History
15.0.0 (2016-03-05)
-------------------
-* Remove the `virtualenv-N.N` script from the package; this can no longer be
+* Remove the ``virtualenv-N.N`` script from the package; this can no longer be
correctly created from a wheel installation.
Resolves :issue:`851`, :issue:`692`
@@ -124,7 +124,7 @@ Release History
* Upgrade setuptools to 19.6
-* Supress any errors from `unset` on different shells (:pull:`843`)
+* Suppress any errors from ``unset`` on different shells (:pull:`843`)
* Normalize letter case for prefix path checking. Fixes :issue:`837`
@@ -485,7 +485,7 @@ Release History
1.8.1 (2012-09-03)
------------------
-* Fixed distribute version used with `--never-download`. Thanks michr for
+* Fixed distribute version used with ``--never-download``. Thanks michr for
report and patch.
* Fix creating Python 3.3 based virtualenvs by unsetting the
@@ -498,7 +498,7 @@ Release History
* **Dropped support for Python 2.4** The minimum supported Python version is
now Python 2.5.
-* Fix `--relocatable` on systems that use lib64. Fixes #78. Thanks Branden
+* Fix ``--relocatable`` on systems that use lib64. Fixes #78. Thanks Branden
Rolston.
* Symlink some additional modules under Python 3. Fixes #194. Thanks Vinay
@@ -556,7 +556,7 @@ Release History
1.7.1.2 (2012-02-17)
--------------------
-* Fixed minor issue in `--relocatable`. Thanks, Cap Petschulat.
+* Fixed minor issue in ``--relocatable``. Thanks, Cap Petschulat.
1.7.1.1 (2012-02-16)
@@ -572,7 +572,7 @@ Release History
* Update embedded pip to version 1.1.
-* Fix `--relocatable` under Python 3. Thanks Doug Hellmann.
+* Fix ``--relocatable`` under Python 3. Thanks Doug Hellmann.
* Added environ PATH modification to activate_this.py. Thanks Doug
Napoleone. Fixes #14.
@@ -592,8 +592,8 @@ Release History
Napoleone for testing and confirmation. Fixes #87.
* Fixed creation of virtualenvs using -p in installs where some modules
- that ought to be in the standard library (e.g. `readline`) are actually
- installed in `site-packages` next to `virtualenv.py`. Thanks Greg Haskins
+ that ought to be in the standard library (e.g. ``readline``) are actually
+ installed in ``site-packages`` next to ``virtualenv.py``. Thanks Greg Haskins
for report and fix. Fixes #167.
* Added activation script for Powershell (signed by Jannis Leidel). Many
diff --git a/docs/conf.py b/docs/conf.py
index 9332aa1..36cf58a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -14,7 +14,7 @@
import os
import sys
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"
# If your extensions are in another directory, add it here.
sys.path.insert(0, os.path.abspath(os.pardir))
@@ -24,58 +24,59 @@ sys.path.insert(0, os.path.abspath(os.pardir))
# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.extlinks']
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.extlinks"]
# Add any paths that contain templates here, relative to this directory.
-#templates_path = ['_templates']
+# templates_path = ['_templates']
# The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
# The master toctree document.
-master_doc = 'index'
+master_doc = "index"
# General substitutions.
-project = 'virtualenv'
-copyright = '2007-2014, Ian Bicking, The Open Planning Project, PyPA'
+project = "virtualenv"
+copyright = "2007-2014, Ian Bicking, The Open Planning Project, PyPA"
# The default replacements for |version| and |release|, also used in various
# other places throughout the built documents.
try:
from virtualenv import __version__
+
# The short X.Y version.
- version = '.'.join(__version__.split('.')[:2])
+ version = ".".join(__version__.split(".")[:2])
# The full version, including alpha/beta/rc tags.
release = __version__
except ImportError:
- version = release = 'dev'
+ version = release = "dev"
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
-#today = ''
+# today = ''
# Else, today_fmt is used as the format for a strftime call.
-today_fmt = '%B %d, %Y'
+today_fmt = "%B %d, %Y"
# List of documents that shouldn't be included in the build.
unused_docs = []
# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
extlinks = {
- 'issue': ('https://github.com/pypa/virtualenv/issues/%s', '#'),
- 'pull': ('https://github.com/pypa/virtualenv/pull/%s', 'PR #'),
+ "issue": ("https://github.com/pypa/virtualenv/issues/%s", "#"),
+ "pull": ("https://github.com/pypa/virtualenv/pull/%s", "PR #"),
}
@@ -85,13 +86,14 @@ extlinks = {
# The style sheet to use for HTML and HTML Help pages. A file of that name
# must exist either in Sphinx' static/ path, or in one of the custom paths
# given in html_static_path.
-#html_style = 'default.css'
+# html_style = 'default.css'
-html_theme = 'default'
+html_theme = "default"
if not on_rtd:
try:
import sphinx_rtd_theme
- html_theme = 'sphinx_rtd_theme'
+
+ html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
except ImportError:
pass
@@ -104,50 +106,50 @@ if not on_rtd:
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = "%b %d, %Y"
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
# Content template for the index page.
-#html_index = ''
+# html_index = ''
# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
# If false, no module index is generated.
-#html_use_modindex = True
+# html_use_modindex = True
# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# html_copy_source = True
# Output file base name for HTML help builder.
-htmlhelp_basename = 'Pastedoc'
+htmlhelp_basename = "Pastedoc"
# Options for LaTeX output
# ------------------------
# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
-#latex_documents = []
+# latex_documents = []
# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
# Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
# If false, no module index is generated.
-#latex_use_modindex = True
+# latex_use_modindex = True
diff --git a/docs/development.rst b/docs/development.rst
index d60f5a8..ea216ea 100644
--- a/docs/development.rst
+++ b/docs/development.rst
@@ -12,11 +12,11 @@ Virtualenv's release schedule is tied to pip's -- each time there's a new pip
release, there will be a new virtualenv release that bundles the new version of
pip.
-Files in the `virtualenv_embedded/` subdirectory are embedded into
-`virtualenv.py` itself as base64-encoded strings (in order to support
-single-file use of `virtualenv.py` without installing it). If your patch
-changes any file in `virtualenv_embedded/`, run `bin/rebuild-script.py` to
-update the embedded version of that file in `virtualenv.py`; commit that and
+Files in the ``virtualenv_embedded/`` subdirectory are embedded into
+``virtualenv.py`` itself as base64-encoded strings (in order to support
+single-file use of ``virtualenv.py`` without installing it). If your patch
+changes any file in ``virtualenv_embedded/``, run ``bin/rebuild-script.py`` to
+update the embedded version of that file in ``virtualenv.py``; commit that and
submit it as part of your patch / pull request.
.. _pip development: https://pip.pypa.io/en/latest/development/
diff --git a/docs/installation.rst b/docs/installation.rst
index a99ff5a..7e6a97d 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -17,7 +17,7 @@ Installation
setuptools < 0.9.7, because easy_install didn't download from PyPI over SSL
and was broken in some subtle ways.
-To install globally with `pip` (if you have pip 1.3 or greater installed globally):
+To install globally with ``pip`` (if you have pip 1.3 or greater installed globally):
::
diff --git a/docs/userguide.rst b/docs/userguide.rst
index dc594d3..ca761d2 100644
--- a/docs/userguide.rst
+++ b/docs/userguide.rst
@@ -65,7 +65,7 @@ To undo these changes to your path (and prompt), just run::
$ deactivate
-On Windows, the equivalent `activate` script is in the ``Scripts`` folder::
+On Windows, the equivalent ``activate`` script is in the ``Scripts`` folder::
> \path\to\env\Scripts\activate
@@ -255,4 +255,3 @@ As well as the extra directories, the search order includes:
#. The ``virtualenv_support`` directory relative to virtualenv.py
#. The directory where virtualenv.py is located.
#. The current directory.
-