Sphinx-Gallery
0.11.1
Versions
v: stable
Versions
dev
stable
Using Sphinx Gallery
Getting Started with Sphinx-Gallery
How to structure your Python scripts for Sphinx-Gallery
Configuration
Who uses Sphinx-Gallery
Advanced usage and information
Advanced usage
Frequently Asked Questions
Sphinx-Gallery Utilities
Example galleries
Gallery of Examples
Notebook style example
Gallery of Examples using Mayavi
Gallery of Examples using PyVista
API and developer reference
Sphinx-Gallery API Reference
Change Log
Fork Sphinx-Gallery on Github
Sphinx-Gallery
Docs
»
Index
Index
A
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
A
add_code_cell() (in module sphinx_gallery.notebook)
add_markdown_cell() (in module sphinx_gallery.notebook)
C
check_binder_conf() (in module sphinx_gallery.binder)
check_duplicate_filenames() (in module sphinx_gallery.gen_gallery)
check_spaces_in_filenames() (in module sphinx_gallery.gen_gallery)
clean_modules() (in module sphinx_gallery.scrapers)
codestr2rst() (in module sphinx_gallery.gen_rst)
collect_gallery_files() (in module sphinx_gallery.gen_gallery)
convert_code_to_md() (in module sphinx_gallery.notebook)
copy_binder_files() (in module sphinx_gallery.binder)
cost_name_key() (in module sphinx_gallery.gen_gallery)
D
DefaultResetArgv (class in sphinx_gallery.gen_gallery)
depart_imgsg_html() (in module sphinx_gallery.directives)
depart_imgsg_latex() (in module sphinx_gallery.directives)
directive_boolean() (in module sphinx_gallery.directives)
directive_fun() (in module sphinx_gallery.notebook)
DummyClass (class in sphinx_gallery.backreferences)
E
embed_code_links() (in module sphinx_gallery.docs_resolv)
ExampleTitleSortKey (class in sphinx_gallery.sorting)
executable_script() (in module sphinx_gallery.gen_rst)
execute_code_block() (in module sphinx_gallery.gen_rst)
execute_script() (in module sphinx_gallery.gen_rst)
ExplicitOrder (class in sphinx_gallery.sorting)
extract_file_config() (in module sphinx_gallery.py_source_parser)
extract_intro_and_title() (in module sphinx_gallery.gen_rst)
F
figure_rst() (in module sphinx_gallery.scrapers)
FileNameSortKey (class in sphinx_gallery.sorting)
FileSizeSortKey (class in sphinx_gallery.sorting)
fill_notebook() (in module sphinx_gallery.notebook)
final_argument_whitespace (sphinx_gallery.directives.ImageSg attribute)
(sphinx_gallery.directives.MiniGallery attribute)
G
gen_binder_rst() (in module sphinx_gallery.binder)
gen_binder_url() (in module sphinx_gallery.binder)
generate_dir_rst() (in module sphinx_gallery.gen_rst)
generate_file_rst() (in module sphinx_gallery.gen_rst)
generate_gallery_rst() (in module sphinx_gallery.gen_gallery)
generate_image_src() (in module sphinx_gallery.notebook)
generate_zipfiles() (in module sphinx_gallery.downloads)
get_data() (in module sphinx_gallery.docs_resolv)
get_default_config_value() (in module sphinx_gallery.gen_gallery)
get_subsections() (in module sphinx_gallery.gen_gallery)
H
handle_exception() (in module sphinx_gallery.gen_rst)
has_content (sphinx_gallery.directives.ImageSg attribute)
I
identify_names() (in module sphinx_gallery.backreferences)
ImagePathIterator (class in sphinx_gallery.scrapers)
ImageSg (class in sphinx_gallery.directives)
imagesg_addnode() (in module sphinx_gallery.directives)
imgsgnode (class in sphinx_gallery.directives)
J
jupyter_notebook() (in module sphinx_gallery.notebook)
jupyter_notebook_skeleton() (in module sphinx_gallery.notebook)
L
list_downloadable_sources() (in module sphinx_gallery.downloads)
M
matplotlib_scraper() (in module sphinx_gallery.scrapers)
mayavi_scraper() (in module sphinx_gallery.scrapers)
md5sum_is_current() (in module sphinx_gallery.gen_rst)
MiniGallery (class in sphinx_gallery.directives)
module
sphinx_gallery
sphinx_gallery.backreferences
sphinx_gallery.binder
sphinx_gallery.directives
sphinx_gallery.docs_resolv
sphinx_gallery.downloads
sphinx_gallery.gen_gallery
sphinx_gallery.gen_rst
sphinx_gallery.notebook
sphinx_gallery.py_source_parser
sphinx_gallery.scrapers
sphinx_gallery.sorting
sphinx_gallery.utils
sphinx_gallery.utils.optipng
N
NameFinder (class in sphinx_gallery.backreferences)
NumberOfCodeLinesSortKey (class in sphinx_gallery.sorting)
O
option_spec (sphinx_gallery.directives.ImageSg attribute)
(sphinx_gallery.directives.MiniGallery attribute)
optional_arguments (sphinx_gallery.directives.ImageSg attribute)
(sphinx_gallery.directives.MiniGallery attribute)
P
parse_config() (in module sphinx_gallery.gen_gallery)
parse_source_file() (in module sphinx_gallery.py_source_parser)
parse_sphinx_docopts() (in module sphinx_gallery.docs_resolv)
patch_warnings() (in module sphinx_gallery.gen_rst)
promote_jupyter_cell_magic() (in module sphinx_gallery.notebook)
prop (sphinx_gallery.backreferences.DummyClass property)
python_to_jupyter_cli() (in module sphinx_gallery.notebook)
python_zip() (in module sphinx_gallery.downloads)
R
remove_config_comments() (in module sphinx_gallery.py_source_parser)
remove_ignore_blocks() (in module sphinx_gallery.py_source_parser)
required_arguments (sphinx_gallery.directives.ImageSg attribute)
(sphinx_gallery.directives.MiniGallery attribute)
resolve() (sphinx_gallery.docs_resolv.SphinxDocLinkResolver method)
rst2md() (in module sphinx_gallery.notebook)
rst_blocks() (in module sphinx_gallery.gen_rst)
run() (sphinx_gallery.backreferences.DummyClass method)
S
save_figures() (in module sphinx_gallery.scrapers)
save_notebook() (in module sphinx_gallery.notebook)
save_rst_example() (in module sphinx_gallery.gen_rst)
save_thumbnail() (in module sphinx_gallery.gen_rst)
setup() (in module sphinx_gallery.gen_gallery)
setup_module() (in module sphinx_gallery.gen_gallery)
sphinx_gallery
module
sphinx_gallery.backreferences
module
sphinx_gallery.binder
module
sphinx_gallery.directives
module
sphinx_gallery.docs_resolv
module
sphinx_gallery.downloads
module
sphinx_gallery.gen_gallery
module
sphinx_gallery.gen_rst
module
sphinx_gallery.notebook
module
sphinx_gallery.py_source_parser
module
sphinx_gallery.scrapers
module
sphinx_gallery.sorting
module
sphinx_gallery.utils
module
sphinx_gallery.utils.optipng
module
SphinxDocLinkResolver (class in sphinx_gallery.docs_resolv)
split_code_and_text_blocks() (in module sphinx_gallery.py_source_parser)
summarize_failing_examples() (in module sphinx_gallery.gen_gallery)
T
touch_empty_backreferences() (in module sphinx_gallery.gen_gallery)
V
visit_imgsg_html() (in module sphinx_gallery.directives)
visit_imgsg_latex() (in module sphinx_gallery.directives)
visit_sg_other() (in module sphinx_gallery.directives)
W
write_computation_times() (in module sphinx_gallery.gen_gallery)
write_junit_xml() (in module sphinx_gallery.gen_gallery)