Skip to content

[DOC] Updated the documentation #8373

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 2 commits into from
Apr 2, 2017
Merged

[DOC] Updated the documentation #8373

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3752832
Updated the documentation
vidursatija Mar 24, 2017
72d9c92
Update documentation
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
14 changes: 12 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,18 @@ 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)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file only list the pip-installable dependencies, as these can be installed directly using:
pip install -r doc-requirements.txt

Unfortunalety, we also have dependencies that need to be installed separetaly (graphviz).


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

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

graphviz is missing from the dependency list.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll add

7. graphviz


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