Skip to content

Commit

Permalink
Fixes #5388 -- Added Documentation for constraint while using Conda
Browse files Browse the repository at this point in the history
This patch adds few notes and warnings in the configuration file documentation,
which will warn the user if he/she is using conda enviroment to setup the docs.
  • Loading branch information
Parth1811 committed Jan 15, 2020
1 parent 013f7be commit 5627954
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/config-file/v2.rst
Expand Up @@ -90,7 +90,7 @@ Example:
.. note::

PDF/epub/htmlzip output is not supported when using MkDocs
PDF/epub/htmlzip output is not supported when using MkDocs

python
~~~~~~
Expand Down Expand Up @@ -120,6 +120,11 @@ The Python version (this depends on :ref:`config-file/v2:build.image`).
:Type: ``number``
:Default: ``3``

.. warning::

If you are using a :ref:`Conda <config-file/v2:conda>` environment to manage
the build, this setting will not have any effect, as the Python version is managed by Conda.

python.install
``````````````

Expand Down Expand Up @@ -150,6 +155,12 @@ Example:
- requirements: docs/requirements.txt
- requirements: requirements.txt
.. warning::

If you are using a :ref:`Conda <config-file/v2:conda>` environment to
manage the build, this setting will not have any effect. Instead
add the extra requirements to the ``environment`` file of Conda.

Packages
''''''''

Expand Down Expand Up @@ -214,6 +225,12 @@ Read the Docs includes some libraries like scipy, numpy, etc.
That you can access to them by enabling this option.
See :ref:`builds:The build environment` for more details.

.. warning::

If you are using a :ref:`Conda <config-file/v2:conda>` environment
to manage the build, this setting will not have any effect, since
the virtual environment creation is managed by Conda.

conda
~~~~~

Expand Down

0 comments on commit 5627954

Please sign in to comment.