Skip to content

Commit d0da627

Browse files
committed
Fixes readthedocs#5388 -- Added Documentation for constraint while using Conda
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.
1 parent 013f7be commit d0da627

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

docs/config-file/v2.rst

+19-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Example:
9090
9191
.. note::
9292

93-
PDF/epub/htmlzip output is not supported when using MkDocs
93+
PDF/epub/htmlzip output is not supported when using MkDocs
9494

9595
python
9696
~~~~~~
@@ -120,6 +120,11 @@ The Python version (this depends on :ref:`config-file/v2:build.image`).
120120
:Type: ``number``
121121
:Default: ``3``
122122

123+
.. note::
124+
125+
If you are using a :ref:`Conda <config-file/v2:conda>` environment to manage
126+
the build, this setting will not have any effect, as the Python version is managed by Conda.
127+
123128
python.install
124129
``````````````
125130

@@ -150,6 +155,12 @@ Example:
150155
- requirements: docs/requirements.txt
151156
- requirements: requirements.txt
152157
158+
.. warning::
159+
160+
If you are using a :ref:`Conda <config-file/v2:conda>` environment to
161+
manage build, then this setting will not have any effect. Instead
162+
add the extra requirements to `environment` file of Conda.
163+
153164
Packages
154165
''''''''
155166

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

228+
.. warning::
229+
230+
If you are using a :ref:`Conda <config-file/v2:conda>` environment
231+
to manage build, you should not set `system_packages` to `True`,
232+
as this setting will not have any effect, since the virtual
233+
environment creation is managed by Conda.
234+
217235
conda
218236
~~~~~
219237

0 commit comments

Comments
 (0)