Add basic conda doc

team-project-import
Eric Holscher 2015-11-30 14:27:13 -08:00
parent c6db870198
commit a693517086
1 changed files with 34 additions and 0 deletions

34
docs/conda.rst Normal file
View File

@ -0,0 +1,34 @@
Conda Support
=============
Read the Docs supports Conda as an environment management tool,
along with Virtualenv.
Conda support is useful for people who depend on C libraries,
and need them installed when building their documentation.
Activating Conda
----------------
Inside your project,
there is a `Use Conda` option that will turn on Conda support.
We support Conda Environment files,
which specify specific packages to install into the environment.
This Conda environment will also have Sphinx and other build time dependencies installed.
It will use the same order of operations that we support currently:
* Environment Creation (``conda create``)
* Dependency Installation (Sphinx, Mkdocs, etc)
* User Package Installation (``conda env update``)
Custom Installs
---------------
If you are running a custom installation of Read the Docs,
you will need the ``conda`` executable installed somewhere on your ``PATH``.
Because of the way ``conda`` works,
we can't safely install it as a normal dependency into the normal Python environment.
.. warning:: Installing conda into a virtualenv will override the ``activate`` script,
making it so you can't properly activate that virtualenv anymore.