rewrite the documentation

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ repos:
         args: [--safe]
         language_version: python3.8
 -   repo: https://github.com/asottile/blacken-docs
-    rev: v1.4.0
+    rev: v1.5.0-1
     hooks:
     -   id: blacken-docs
         additional_dependencies: [black==19.10b0]
@@ -38,7 +38,7 @@ repos:
         additional_dependencies: ["flake8-bugbear == 20.1.2"]
         language_version: python3.8
 -   repo: https://github.com/asottile/pyupgrade
-    rev: v1.26.0
+    rev: v1.26.2
     hooks:
     -   id: pyupgrade
 -   repo: https://github.com/pre-commit/pygrep-hooks

.readthedocs.yml

@@ -0,0 +1,18 @@
+version: 2
+build:
+  image: latest
+formats:
+  - htmlzip
+  - epub
+  - pdf
+python:
+   version: 3.7
+   install:
+      - method: pip
+        path: .
+        extra_requirements:
+            - docs
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true

LICENSE.txt → LICENSE

@@ -1,6 +1,4 @@
-Copyright (c) 2007 Ian Bicking and Contributors
-Copyright (c) 2009 Ian Bicking, The Open Planning Project
-Copyright (c) 2011-2016 The virtualenv developers
+Copyright (c) 2020-202x The virtualenv developers
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

MANIFEST.in

@@ -4,7 +4,6 @@ exclude .gitignore
 exclude .github/*
 
 exclude azure-pipelines.yml
-exclude CONTRIBUTING.rst
 exclude readthedocs.yml
 exclude MANIFEST.in
 

docs/_static/custom.css

@@ -0,0 +1,65 @@
+.wy-nav-content {
+    max-width: 51.5em;
+    padding: 1em;
+}
+
+#virtualenv img {
+    margin-bottom: 6px;
+}
+
+/* override table width restrictions */
+.wy-table-responsive table th, .wy-table-responsive table td {
+    /* !important prevents the common CSS stylesheets from
+       overriding this as on RTD they are loaded after this stylesheet */
+    white-space: normal !important;
+    padding: 6px !important;
+}
+
+.wy-table-responsive {
+    overflow: visible !important;
+}
+
+.rst-content table.docutils td ol {
+    margin-bottom: 0;
+}
+
+.rst-content table.docutils td ul {
+    margin-bottom: 0;
+}
+
+.rst-content table.docutils td p {
+    margin-bottom: 0;
+}
+
+div[class*="highlight-"] {
+    margin-bottom: 12px;
+}
+
+table {
+    margin-left: 20px !important;
+}
+
+#release-history p {
+    margin-bottom: 0;
+    margin-top: 0;
+}
+
+#release-history h3 {
+    margin-bottom: 6px;
+}
+
+#release-history ul {
+    margin-bottom: 12px;
+}
+
+#release-history ul ul {
+    margin-bottom: 0;
+}
+
+#release-history h2 {
+    margin-bottom: 12px;
+}
+
+.rst-content code {
+    padding: 2px;
+}

docs/changelog/1465.doc.rst

@@ -0,0 +1 @@
+Create the first iteration of the new documentation - by :user:`gaborbernat`.

docs/changelog/1508.bugfix.rst

@@ -0,0 +1,2 @@
+Bash activation script should have no extensions instead of ``.sh`` (this fixes the :pypi:`virtualenvwrapper`
+integration) - by :user:`gaborbernat`.

docs/changelog/1510.bugfix.rst

@@ -0,0 +1,7 @@
+Show less information when we run with a single verbosity (``-v``):
+
+- no longer shows accepted interpreters information (as the last proposed one is always the accepted one),
+- do not display the ``str_spec`` attribute for ``PythonSpec`` as these can be deduced from the other attributes,
+- for the ``app-data`` seeder do not show the type of lock, only the path to the app data directory,
+
+By :user:`gaborbernat`.

docs/changelog/1512.bugfix.rst

@@ -0,0 +1,2 @@
+Fixed cannot discover a python interpreter that has already been discovered under a different path (such is the case
+when we have multiple symlinks to the same interpreter) - by :user:`gaborbernat`.

docs/changelog/1514.bugfix.rst

@@ -1 +1 @@
-Support relative paths for ``-p`` - by ``gaborbernat``.
+Support relative paths for ``-p`` - by :user:`gaborbernat`.

docs/changelog/1515.bugfix.rst → docs/changelog/1515.feature.rst

@@ -11,4 +11,4 @@ Improve base executable discovery mechanism:
   system pythons version - these two can differ if the OS upgraded the system python underneath and the virtualenv
   host was created via copy),
 
-by ``gaborbernat``.
+by :user:`gaborbernat`.

docs/changelog/1516.bugfix.rst

@@ -1 +1 @@
-Creating virtual environments in parallel fail with cannot acquire lock within app data - by ``gaborbernat``.
+Creating virtual environments in parallel fail with cannot acquire lock within app data - by :user:`gaborbernat`.

docs/changelog/1517.bugfix.rst

@@ -1 +1 @@
-pth files were not processed under Debian CPython2 interpreters - by ``gaborbernat``.
+pth files were not processed under Debian CPython2 interpreters - by :user:`gaborbernat`.

docs/changelog/1527.bugfix.rst → docs/changelog/1527.feature.rst

@@ -1,2 +1,2 @@
 Generate ``bash`` and ``fish`` activators on Windows too (as these can be available with git bash, cygwin or mysys2)
-- by ``gaborbernat``.
+- by :user:`gaborbernat`.

docs/changelog/1530.bugfix.rst

@@ -0,0 +1,2 @@
+Fix prompt not displayed correctly with upcoming fish 3.10 due to us not preserving ``$pipestatus`` - by
+:user:`krobelus`.

docs/changelog/1531.doc.rst

@@ -1 +1 @@
-Project readme is now of type MarkDown instead of reStructuredText - by ``gaborbernat``.
+Project readme is now of type MarkDown instead of reStructuredText - by :user:`gaborbernat`.

docs/changelog/1531.misc.rst → docs/changelog/1531.feature.rst

@@ -1 +1 @@
-Upgrade the bundled ``wheel`` package from ``0.34.0`` to ``0.34.2`` - by ``gaborbernat``.
+Upgrade the bundled ``wheel`` package from ``0.34.0`` to ``0.34.2`` - by :user:`gaborbernat`.

docs/changelog/1535.bugfix.rst

@@ -1,2 +1,2 @@
 Stable order within ``pyenv.cfg`` and add ``include-system-site-packages`` only for creators that reference a global
-Python - by ``gaborbernat``.
+Python - by user:`gaborbernat`.

docs/changelog/template.jinja2

@@ -1,31 +1,36 @@
-{% for section, _ in sections.items() %}
-{% set underline = underlines[0] %}
-{% if section %}
-{{section}}
-{{ underline * section|length }}
-{% set underline = underlines[1] %}
+{% set top_underline = underlines[0] %}
+{% if versiondata.name %}
+v{{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.version + versiondata.date)|length + 4)}}
+{% else %}
+{{ versiondata.version }} ({{ versiondata.date }})
+{{ top_underline * ((versiondata.version + versiondata.date)|length + 3)}}
 {% endif %}
 
+{% for section, _ in sections.items() %}
+{% set underline = underlines[1] %}
 {% if sections[section] %}
-{% for category, val in definitions.items() if category in sections[section] %}
-{{ definitions[category]['name'] }}
-{{ underline * definitions[category]['name']|length }}
+{% for category, val in definitions.items() if category in sections[section]%}
+{{ definitions[category]['name'] }} - {{ versiondata.version }}
+{{ underline * ((definitions[category]['name']  + versiondata.version)|length + 3)}}
 {% if definitions[category]['showcontent'] %}
-
 {% for text, values in sections[section][category].items() %}
 - {{ text }} ({{ values|join(', ') }})
 {% endfor %}
 
 {% else %}
 - {{ sections[section][category]['']|join(', ') }}
-{% endif %}
 
+{% endif %}
 {% if sections[section][category]|length == 0 %}
 No significant changes.
+
+{% else %}
 {% endif %}
 {% endfor %}
-
 {% else %}
 No significant changes.
+
+
 {% endif %}
 {% endfor %}