Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docs/contrib #12584

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
wants to merge 5 commits into from
Closed

Docs/contrib #12584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7005e23
added specific instructions for setting up a dev environment and inst…
alisonspencer Oct 21, 2018
1e59b4c
merged in upstream changes
alisonspencer Dec 2, 2018
1f3637f
removed duplication of instructions between contributing and documenting
alisonspencer Dec 2, 2018
fabaac9
removed duplication of instructions between contributing and documenting
alisonspencer Dec 2, 2018
2f05283
fixed rst title underlining
alisonspencer Dec 3, 2018
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
5 changes: 3 additions & 2 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ environment to build Matplotlib from source.
To work on Matplotlib sources, it is strongly recommended to set up an alternative
development environment, using the something like `virtual environments in python
<http://docs.python-guide.org/en/latest/dev/virtualenvs/>`_, or a
`conda environment <http://conda.pydata.org/docs/using/envs.html>`_.
`conda environment <https://conda.io/docs/user-guide/tasks/manage-environments.html>`_.

If you choose to use an already existing environment, and not a clean virtual or
conda environment, uninstall the current version of Matplotlib in that environment
Expand Down Expand Up @@ -158,6 +158,7 @@ environment is set up properly::

* :ref:`testing`

.. _how_to_contribute:

Contributing code
=================
Expand Down Expand Up @@ -315,7 +316,7 @@ documentation is also a very important part of the project and often doesn't
get as much attention as it deserves. If you find a typo in the documentation,
or have made improvements, do not hesitate to send an email to the mailing
list or submit a GitHub pull request. Full documentation can be found under
the doc/ directory.
the doc/ directory. Details for contributing to the documentation can be found :ref:`here <documenting-matplotlib>`.

It also helps us if you spread the word: reference the project from your blog
and articles or link to it from your website!
Expand Down
39 changes: 29 additions & 10 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,27 +41,46 @@ documentation built into their comments. Don't directly edit the
``.rst`` files in :file:`doc/gallery` and :file:`doc/tutorials` as they are
regenerated when the documentation are built.

Installing dependencies

Dependencies
-----------------------
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
-----------------------
------------


The documentation for Matplotlib is generated from reStructuredText (ReST_)
using the Sphinx_ documentation generation tool. There are several extra
requirements that are needed to build the documentation. They are listed in
:file:`doc-requirements.txt` and listed below:
requirements, in addition to those in :ref:`Contributing <contributing>`, that are needed to build the documentation. They are listed in
Copy link
Member

Choose a reason for hiding this comment

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

https://16523-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/devel/contributing.html actially doesn't list the dependencies.

The whole paragraph could be rephrased to:

Building the documentation requires the following extra requirements:

  • Sphinx
    ...

See :file:doc-requirements.txt for the exact version requirements. You can also use this file to install the dependencies using your package manager:

python -m pip install -r doc-requirements.txt
# or
conda install --file doc-requirements.txt

:file:`doc-requirements.txt` and below:

* Sphinx>=1.3, !=1.5.0, !=1.6.4, !=1.7.3
* Sphinx
* colorspacious
* IPython
* numpydoc>=0.8
* Pillow>=3.4
* sphinx-gallery>=0.2
* numpydoc
* Pillow
* sphinx-gallery
* LaTeX
* graphviz

.. note::

* You'll need a minimal working LaTeX distribution for many examples to run.
* `Graphviz <http://www.graphviz.org/Download.php>`_ is not a Python package,
and needs to be installed separately.
* You'll need a minimal working `LaTeX <https://www.latex-project.org/>`_ distribution for many examples in the documentation to run.
* `Graphviz <http://www.graphviz.org/>`_ is not a Python package,
and needs to be installed separately.


Install dependencies and create a documentation development environment
-----------------------------------------------------------------------

* See :ref:`installing_for_devs` and :ref:`how_to_contribute` to get the latest version of the code, set up a development environment, and create pull requests.

* Install the python dependencies in `doc-requirements.txt`:

.. note::

* colorspacious must be installed using conda-forge, not conda

* Install the `LaTeX <https://www.latex-project.org/>`_ version for your OS
* Install `Graphviz <http://www.graphviz.org/>`_ for your OS



Building the docs
-----------------
Expand Down