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

Skip to content

Commit 58da13c

Browse files
jklymakjklymak
committed
DOC: use mpl-sphinx-theme for navbar, social, logo
2 parents e509468 + b3efa5b commit 58da13c

File tree

11 files changed

+16
-62
lines changed

11 files changed

+16
-62
lines changed

‎doc/_templates/mpl_nav_bar.html

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎doc/conf.py

Lines changed: 2 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -291,45 +291,22 @@ def _check_dependencies():
291291
f"mpl.css?{SHA}",
292292
]
293293

294-
html_theme = "pydata_sphinx_theme"
294+
html_theme = "mpl_sphinx_theme"
295295

296296
# The name for this set of Sphinx documents. If None, it defaults to
297297
# "<project> v<release> documentation".
298298
# html_title = None
299299

300300
# The name of an image file (within the static path) to place at the top of
301301
# the sidebar.
302-
html_logo = "_static/logo2.svg"
303302
html_theme_options = {
304303
"logo_link": "index",
305304
# collapse_navigation in pydata-sphinx-theme is slow, so skipped for local
306305
# and CI builds https://github.com/pydata/pydata-sphinx-theme/pull/386
307306
"collapse_navigation": not is_release_build,
308-
"icon_links": [
309-
{
310-
"name": "gitter",
311-
"url": "https://gitter.im/matplotlib",
312-
"icon": "fab fa-gitter",
313-
},
314-
{
315-
"name": "discourse",
316-
"url": "https://discourse.matplotlib.org",
317-
"icon": "fab fa-discourse",
318-
},
319-
{
320-
"name": "GitHub",
321-
"url": "https://github.com/matplotlib/matplotlib",
322-
"icon": "fab fa-github-square",
323-
},
324-
{
325-
"name": "twitter",
326-
"url": "https://twitter.com/matplotlib/",
327-
"icon": "fab fa-twitter-square",
328-
},
329-
],
330307
"show_prev_next": False,
331-
"navbar_center": ["mpl_nav_bar.html"],
332308
}
309+
333310
include_analytics = is_release_build
334311
if include_analytics:
335312
html_theme_options["google_analytics_id"] = "UA-55954603-1"

‎doc/devel/contributing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ Other ways to contribute
275275
It also helps us if you spread the word: reference the project from your blog
276276
and articles or link to it from your website! If Matplotlib contributes to a
277277
project that leads to a scientific publication, please follow the
278-
:doc:`/users/backmatter/citing` guidelines.
278+
:doc:`/users/project/citing` guidelines.
279279

280280
.. _coding_guidelines:
281281

‎doc/users/index.rst

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,15 @@
77
Users guide
88
###########
99

10+
Tutorials and examples
11+
######################
12+
13+
.. toctree::
14+
:maxdepth: 1
15+
16+
../plot_types/index.rst
17+
../tutorials/index.rst
18+
../gallery/index.rst
1019

1120
General
1221
#######
@@ -28,16 +37,5 @@ Reference
2837

2938
../api/index.rst
3039
../devel/index.rst
31-
backmatter/index.rst
40+
project/index.rst
3241
release_notes.rst
33-
34-
35-
Tutorials and examples
36-
######################
37-
38-
.. toctree::
39-
:maxdepth: 1
40-
41-
../plot_types/index.rst
42-
../tutorials/index.rst
43-
../gallery/index.rst

‎doc/users/backmatter/citing.rst renamed to ‎doc/users/project/citing.rst

File renamed without changes.

‎doc/users/backmatter/credits.rst renamed to ‎doc/users/project/credits.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Matplotlib was written by John D. Hunter, with contributions from an
1313
ever-increasing number of users and developers. The current lead developer is
1414
Thomas A. Caswell, who is assisted by many `active developers
1515
<https://www.openhub.net/p/matplotlib/contributors>`_.
16-
Please also see our instructions on :doc:`/users/backmatter/citing`.
16+
Please also see our instructions on :doc:`/users/project/citing`.
1717

1818
The following is a list of contributors extracted from the
1919
git revision control history of the project:

‎doc/users/backmatter/history.rst renamed to ‎doc/users/project/history.rst

File renamed without changes.

‎doc/users/backmatter/index.rst renamed to ‎doc/users/project/index.rst

File renamed without changes.

‎doc/users/backmatter/license.rst renamed to ‎doc/users/project/license.rst

File renamed without changes.

‎requirements/doc/doc-requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ ipython
1313
ipywidgets
1414
numpydoc>=0.8
1515
packaging>=20
16-
pydata-sphinx-theme>=0.6.0
16+
mpl-sphinx-theme
1717
sphinxcontrib-svg2pdfconverter>=1.1.0
1818
sphinx-gallery>=0.10
1919
sphinx-copybutton

‎tools/cache_zenodo_svg.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ def _get_xdg_cache_dir():
106106
}
107107
doc_dir = Path(__file__).parent.parent.absolute() / "doc"
108108
target_dir = doc_dir / "_static/zenodo_cache"
109-
citing = doc_dir / "users/backmatter/citing.rst"
109+
citing = doc_dir / "users/project/citing.rst"
110110
target_dir.mkdir(exist_ok=True, parents=True)
111111
header = []
112112
footer = []

0 commit comments

Comments
 (0)