From fd9a4e155b8e950800c9565d78a96bda8305b6c3 Mon Sep 17 00:00:00 2001
From: Fridolin Pokorny <fridolin.pokorny@gmail.com>
Date: Mon, 8 Feb 2021 14:56:03 +0100
Subject: [PATCH] Document selective pre-releases

---
 docs/source/compatibility.rst         |  3 +
 docs/source/experimental_features.rst | 97 +++++++++++++++++++++++++++
 2 files changed, 100 insertions(+)
 create mode 100644 docs/source/experimental_features.rst

diff --git a/docs/source/compatibility.rst b/docs/source/compatibility.rst
index e95f5a258..303a8a186 100644
--- a/docs/source/compatibility.rst
+++ b/docs/source/compatibility.rst
@@ -94,6 +94,9 @@ and thus the recommendation engine never recommends the given package when
 running any Python 3.9. This is considered a corner case as this is not seen
 much in the Python ecosystem.
 
+Resolver also implements experimental features that extend the current feature
+set of Pipenv or pip. See :ref:`experimental_features` for more details.
+
 Python package indexes
 ======================
 
diff --git a/docs/source/experimental_features.rst b/docs/source/experimental_features.rst
new file mode 100644
index 000000000..d59613bd7
--- /dev/null
+++ b/docs/source/experimental_features.rst
@@ -0,0 +1,97 @@
+. _experimental_features:
+
+Resolver's experimental features
+--------------------------------
+
+By using Thoth as a recommendation engine, you can enable some experimental
+features. These experimental features diverge from the ones provided by the
+official Python packaging, but can be nifty in some cases.
+
+All the experimental features require using `Pipenv
+<https://docs.pipenv.org/>`__ files (``Pipfile`` and ``Pipfile.lock``) and are
+enabled by stating them in the ``[thoth]`` specific section.
+
+.. note::
+
+  You can use `micropipenv <https://github.com/thoth-station/micropipenv>`__ to
+  convert resulting Pipfile/Pipfile.lock files to requirement files if you wish
+  to use `pip-tools <https://pypi.org/project/pip-tools>`__ or raw pip.
+
+To maintain compatibility with Pipenv, any changes done in ``[thoth]`` section
+are not checked for changes (the ``--deploy`` flag which verifies hash of
+Pipfile during deployment). This means you can perform any changes to Thoth
+specific configuration and they will not block using Pipenv. Also Pipenv
+ignores ``[thoth]`` section. This section simply acts as a set of hints for
+Thoth resolver to resolve specific set of packages based on the configuration.
+Generally, these options will result in different stacks resolved in
+comparision to using other resolvers (such as Pipenv, pip-tools, ...).
+
+Selectively enabling pre-releases
+=================================
+
+This is implementation of `PEEP-0007 Pipenv draft
+<https://github.com/pypa/pipenv/pull/4607>`__. As Pipenv allows only turning
+on/off pre-releases for all the packages in the dependency graph, this option
+enables users to selectively turn on/off pre-releases for any package in the
+dependency graph - transitive as well as direct packages.
+
+This can be useful if some packages should be present as pre-releases or they
+do not have any release yet, except for pre-releases. See the `upstream
+discussion <https://github.com/pypa/pipenv/issues/1760>`__.
+
+The following configuration will enable resolving pre-releases that match
+`tensorflow>=2.3`:
+
+.. code-block:: toml
+
+  [[source]]
+  url = "https://pypi.org/simple"
+  verify_ssl = true
+  name = "pypi"
+
+  [packages]
+  tensorflow = ">=2.3"
+
+  [dev-packages]
+
+  [requires]
+  python_version = "3.9"
+
+  [pipenv]
+  allow_prereleases = false
+
+  [thoth.allow_prereleases]
+  tensorflow = true
+
+It is important to make sure the Pipenv specific ``allow_prereleases``
+configuration option is set to ``false`` (it is by default) Otherwise, all
+packages in the dependency graph will be treated as pre-releases and
+``[thoth.allow_prereleases]`` section will be ignored.
+
+It is also possible to allow pre-releases for packages that occur in the
+dependency graph but are not direct dependencies of the application stack:
+
+.. code-block:: toml
+
+  [[source]]
+  url = "https://pypi.org/simple"
+  verify_ssl = true
+  name = "pypi"
+
+  [packages]
+  tensorflow = "*"
+
+  [dev-packages]
+
+  [requires]
+  python_version = "3.9"
+
+  [pipenv]
+  allow_prereleases = false
+
+  [thoth.allow_prereleases]
+  numpy = true
+
+In this case, also pre-releases of NumPy will be considered during the
+dependency resolution if NumPy occurs in the stack (a transitively dependency
+of the application stack) and NumPy pre-releases are available.