Skip to content
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

Jump to bottom

Use mpl-sphinx-theme #99

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Use mpl-sphinx-theme #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 15 additions & 0 deletions doc/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
API
===

.. autosummary::
:toctree: generated/

cycler
Cycler
concat

The public API of :py:mod:`cycler` consists of a class `Cycler`, a
factory function :func:`cycler`, and a concatenation function
:func:`concat`. The factory function provides a simple interface for
creating 'base' `Cycler` objects while the class takes care of the
composition and iteration logic.
20 changes: 15 additions & 5 deletions doc/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,12 +113,22 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
# html_theme = 'basic'
html_theme = 'mpl_sphinx_theme'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}
html_theme_options = {
'navbar_center': 'navbar-nav.html',
"icon_links": [
{
"name": "GitHub",
"url": "https://github.com/matplotlib/cycler",
"icon": "fa-brands fa-square-github",
"type": "fontawesome",
}
]
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
Expand All @@ -142,7 +152,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = []
html_static_path = ['static']

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
Expand Down Expand Up @@ -272,8 +282,8 @@
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False

intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
'matplotlb': ('https://matplotlib.org', None)}
# intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
# 'matplotlb': ('https://matplotlib.org', None)}

# ################ numpydoc config ####################
numpydoc_show_class_members = False
Loading
Loading