Skip to content

Add sphinx-copybutton to docs #12997

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
timhoffm merged 2 commits into from
Dec 17, 2018
Merged

Add sphinx-copybutton to docs #12997

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c4e55f9
Add sphinx-copybutton to docs
dstansby Dec 16, 2018
d499cf5
Directly include documentation requirements in docs
dstansby Dec 16, 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
3 changes: 2 additions & 1 deletion doc-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Requirements for building docs
# You will first need a matching matplotlib installed
# You will first need a matching matplotlib installation
# e.g (from the matplotlib root directory)
# pip install -e .
#
Expand All @@ -13,3 +13,4 @@ ipywidgets
numpydoc>=0.8
pillow>=3.4
sphinx-gallery>=0.2
sphinx-copybutton
5 changes: 3 additions & 2 deletions doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
# General configuration
# ---------------------

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.autosummary',
Expand All @@ -45,6 +45,7 @@
'sphinxext.math_symbol_table',
'sphinxext.mock_gui_toolkits',
'sphinxext.skip_deprecated',
'sphinx_copybutton',
]

exclude_patterns = ['api/api_changes/*', 'users/whats_new/*']
Expand Down
13 changes: 4 additions & 9 deletions doc/devel/documenting_mpl.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,10 @@ Installing dependencies
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:

* Sphinx>=1.3, !=1.5.0, !=1.6.4, !=1.7.3
* colorspacious
* IPython
* numpydoc>=0.8
* Pillow>=3.4
* sphinx-gallery>=0.2
* graphviz
:file:`doc-requirements.txt`, which is shown below:

.. include:: ../../doc-requirements.txt
:literal:

.. note::

Expand Down