Skip to content

Commit 7c9ba14

Browse files
DOC: update sphinx requirements for doc building (#13532)
1 parent 8f8d75d commit 7c9ba14

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

doc/source/contributing.rst

+10-8
Original file line numberDiff line numberDiff line change
@@ -351,31 +351,33 @@ How to build the *pandas* documentation
351351
Requirements
352352
~~~~~~~~~~~~
353353

354-
To build the *pandas* docs there are some extra requirements: you will need to
354+
First, you need to have a development environment to be able to build pandas
355+
(see the docs on :ref:`creating a development environment above <contributing.dev_env>`).
356+
Further, to build the docs, there are some extra requirements: you will need to
355357
have ``sphinx`` and ``ipython`` installed. `numpydoc
356358
<https://github.com/numpy/numpydoc>`_ is used to parse the docstrings that
357359
follow the Numpy Docstring Standard (see above), but you don't need to install
358360
this because a local copy of numpydoc is included in the *pandas* source
359361
code.
362+
`nbconvert <https://nbconvert.readthedocs.io/en/latest/>`_ and
363+
`nbformat <http://nbformat.readthedocs.io/en/latest/>`_ are required to build
364+
the Jupyter notebooks included in the documentation.
360365

361-
It is easiest to :ref:`create a development environment <contributing.dev_env>`, then install::
366+
If you have a conda environment named ``pandas_dev``, you can install the extra
367+
requirements with::
362368

363369
conda install -n pandas_dev sphinx ipython nbconvert nbformat
364370

365-
Furthermore, it is recommended to have all `optional dependencies
366-
<http://pandas.pydata.org/pandas-docs/dev/install.html#optional-dependencies>`_
371+
Furthermore, it is recommended to have all :ref:`optional dependencies <install.optional_dependencies>`.
367372
installed. This is not strictly necessary, but be aware that you will see some error
368373
messages when building the docs. This happens because all the code in the documentation
369374
is executed during the doc build, and so code examples using optional dependencies
370375
will generate errors. Run ``pd.show_versions()`` to get an overview of the installed
371376
version of all dependencies.
372-
`nbconvert <https://nbconvert.readthedocs.io/en/latest/>`_ and `nbformat <http://nbformat.readthedocs.io/en/latest/>`_ are required to build the Jupyter notebooks
373-
included in the documentation.
374377

375378
.. warning::
376379

377-
You need to have ``sphinx`` version 1.2.2 or newer, but older than version 1.3.
378-
Versions before 1.1.3 should also work.
380+
You need to have ``sphinx`` version >= 1.3.2.
379381

380382
Building the documentation
381383
~~~~~~~~~~~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)