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

Skip to content

DOC: Sort gallery subsections by filename #11214

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 1 commit into from
Closed

DOC: Sort gallery subsections by filename #11214

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
2 changes: 1 addition & 1 deletion doc-requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ ipython
ipywidgets
numpydoc>=0.4
pillow
sphinx-gallery>=0.1.12
sphinx-gallery>=0.1.13
4 changes: 3 additions & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,11 @@ def _check_deps():
_check_deps()

# Import only after checking for dependencies.
from sphinx_gallery.sorting import ExplicitOrder
from sphinx_gallery.sorting import ExplicitOrder, FileNameSortKey
# This is only necessary to monkey patch the signature later on.
from sphinx_gallery import gen_rst


if shutil.which('dot') is None:
raise OSError(
"No binary named dot - you need to install the Graph Visualization "
Expand Down Expand Up @@ -129,6 +130,7 @@ def _check_deps():
},
'backreferences_dir': 'api/_as_gen',
'subsection_order': ExplicitOrder(explicit_order_folders),
'within_subsection_order': FileNameSortKey,
'min_reported_time': 1,
}

Expand Down
4 changes: 2 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 @@ -42,12 +42,12 @@ 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
* Sphinx>=1.3, !=1.5.0, !=1.6.4, !=1.7.3
* colorspacious
* IPython
* numpydoc>=0.4
* Pillow
* sphinx-gallery>=0.1.12
* sphinx-gallery>=0.1.13
* graphviz

.. note::
Expand Down