Skip to content

Bugfix for docs build instructions #2897

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2019
Merged

Bugfix for docs build instructions #2897

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions doc/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -285,17 +285,23 @@ How to build the *xarray* documentation

Requirements
~~~~~~~~~~~~
Make sure to follow the instructions on :ref:`creating a development environment above <contributing.dev_env>`, but
to build the docs you need to use the environment file ``doc/environment.yml``.

First, you need to have a development environment to be able to build xarray
(see the docs on :ref:`creating a development environment above <contributing.dev_env>`).
.. code-block:: none

Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~
# Create and activate the docs environment
conda env create -f doc/environment.yml
conda activate xarray-docs

In your development environment, install ``sphinx``, ``sphinx_rtd_theme``,
``sphinx-gallery`` and ``numpydoc``::
# or with older versions of Anaconda:
source activate xarray-docs

conda install -c conda-forge sphinx sphinx_rtd_theme sphinx-gallery numpydoc
# Build and install xarray
pip install -e .

Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~

Navigate to your local ``xarray/doc/`` directory in the console and run::

Expand Down