Skip to content

Commit d74049d

Browse files
authored
Merge pull request #5743 from mriedem/5741-building-docs
Make sure notebook is pip installed when building docs
2 parents 466f0f3 + 1ca45de commit d74049d

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

CONTRIBUTING.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,19 +171,17 @@ Building the Documentation
171171
To build the documentation you'll need `Sphinx <http://www.sphinx-doc.org/>`_,
172172
`pandoc <http://pandoc.org/>`_ and a few other packages.
173173

174-
To install (and activate) a `conda environment`_ named ``notebook_docs``
174+
To install (and activate) a conda environment named ``notebook_docs``
175175
containing all the necessary packages (except pandoc), use::
176176

177-
conda env create -f docs/environment.yml
177+
conda create -n notebook_docs pip
178178
conda activate notebook_docs # Linux and OS X
179-
activate notebook_docs # Windows
180-
181-
.. _conda environment:
182-
https://conda.io/docs/user-guide/tasks/manage-environments.html#creating-an-environment-from-an-environment-yml-file
179+
activate notebook_docs # Windows
180+
pip install .[docs]
183181

184182
If you want to install the necessary packages with ``pip``, use the following instead::
185183

186-
pip install -r docs/doc-requirements.txt
184+
pip install .[docs]
187185

188186
Once you have installed the required packages, you can build the docs with::
189187

0 commit comments

Comments
 (0)