File: reference.rst

package info (click to toggle)
sphinx-gallery 0.19.0-2
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,340 kB
  • sloc: python: 10,346; makefile: 216; lisp: 15; sh: 11; cpp: 9
file content (50 lines) | stat: -rw-r--r-- 1,006 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

.. _sphx_glr_api_reference:

Sphinx-Gallery API Reference
============================

.. note::
   Sphinx-Gallery is typically used indirectly via Sphinx execution and
   configuration variables, see :ref:`configuration` for how to do this.
   However, as a standard  Python project, we document many functions and
   classes as well below, even though these will typically not be needed
   by end users.

.. currentmodule:: sphinx_gallery

.. automodule:: sphinx_gallery
   :no-members:
   :no-inherited-members:

:py:mod:`sphinx_gallery`:

.. autosummary::
   :toctree: gen_modules/
   :template: module.rst

   gen_gallery
   backreferences
   gen_rst
   scrapers
   py_source_parser
   block_parser
   docs_resolv
   notebook
   downloads
   sorting
   directives

.. currentmodule:: sphinx_gallery.utils

.. automodule:: sphinx_gallery.utils
   :no-members:
   :no-inherited-members:

:py:mod:`sphinx_gallery.utils`:

.. autosummary::
   :toctree: gen_modules/
   :template: module.rst

   optipng