Skip to content

Document the documentation build requirements (closes #8174) #8191

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

Closed
vidursatija wants to merge 3 commits into from
Closed

Document the documentation build requirements (closes #8174) #8191

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5479405
Updating file as per #8174
vidursatija Mar 3, 2017
a21fd1f
Updating file as per #8191
vidursatija Mar 4, 2017
43576a0
Merge branch 'master' into patch-1
vidursatija Mar 24, 2017
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
13 changes: 11 additions & 2 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,17 @@ Getting started
===============

The documentation for matplotlib is generated from ReStructured Text using the
Sphinx_ documentation generation tool. Sphinx-1.3 or later and numpydoc 0.4 or
later is required.

Sphinx_ documentation generation tool.
The requirements are as follows (https://github.com/matplotlib/matplotlib/blob/master/doc-requirements.txt)

1. Sphinx-1.0 or later(Version 1.5.0 is not supported)
2. numpydoc 0.4 or later
3. IPython
4. Mock
5. colorspacious
6. pillow
=======

The documentation sources are found in the :file:`doc/` directory in
the trunk. To build the users guide in html format, cd into
Expand Down