module sphinxext

Short summary

module pyquickhelper.sphinxext

Subpart related to sphinx extensions

Functions

function

truncated documentation

get_default_extensions

Returns a list of default extensions.

get_default_standard_extensions

Returns a list of standard extensions.

Documentation

Subpart related to sphinx extensions

Todo(enhancement): add directive for a sortable table

Based on slickgrid.

issue

source on GitHub

pyquickhelper.sphinxext.get_default_extensions(load_bokeh=False)[source][source]

Returns a list of default extensions.

Parameters

load_bokeh – loads bokeh extensions (can be disabled as it is quite slow)

Returns

list of Sphinx extensions

The current list is:

<<<

from pyquickhelper.sphinxext import get_default_extensions
print("\n".join(get_default_extensions()))

>>>

    pyquickhelper.sphinxext.sphinx_toctree_extension
    pyquickhelper.sphinxext.sphinx_blog_extension
    pyquickhelper.sphinxext.sphinx_runpython_extension
    pyquickhelper.sphinxext.sphinx_sharenet_extension
    pyquickhelper.sphinxext.sphinx_todoext_extension
    pyquickhelper.sphinxext.sphinx_bigger_extension
    pyquickhelper.sphinxext.sphinx_githublink_extension
    pyquickhelper.sphinxext.sphinx_runpython_extension
    pyquickhelper.sphinxext.sphinx_mathdef_extension
    pyquickhelper.sphinxext.sphinx_blocref_extension
    pyquickhelper.sphinxext.sphinx_faqref_extension
    pyquickhelper.sphinxext.sphinx_exref_extension
    pyquickhelper.sphinxext.sphinx_nbref_extension
    pyquickhelper.sphinxext.sphinx_docassert_extension
    pyquickhelper.sphinxext.sphinx_autosignature
    pyquickhelper.sphinxext.sphinx_template_extension
    pyquickhelper.sphinxext.sphinx_cmdref_extension
    pyquickhelper.sphinxext.sphinx_epkg_extension
    pyquickhelper.sphinxext.sphinx_rst_builder
    pyquickhelper.sphinxext.sphinx_md_builder
    pyquickhelper.sphinxext.sphinx_latex_builder
    pyquickhelper.sphinxext.sphinx_doctree_builder
    pyquickhelper.sphinxext.sphinx_postcontents_extension
    pyquickhelper.sphinxext.sphinx_tocdelay_extension
    pyquickhelper.sphinxext.sphinx_youtube_extension
    sphinx.ext.graphviz
    sphinx.ext.imgmath
    sphinx.ext.todo
    sphinx.ext.autodoc
    sphinxcontrib.imagesvg
    matplotlib.sphinxext.plot_directive
    pyquickhelper.sphinxext.sphinximages.sphinxtrib.images
    pyquickhelper.sphinxext.sphinx_collapse_extension
    pyquickhelper.sphinxext.sphinx_gdot_extension
    pyquickhelper.sphinxext.sphinx_video_extension
    pyquickhelper.sphinxext.sphinx_image_extension
    pyquickhelper.sphinxext.sphinx_downloadlink_extension
    pyquickhelper.sphinxext.sphinx_quote_extension
    pyquickhelper.sphinxext.sphinx_gitlog_extension

source on GitHub

pyquickhelper.sphinxext.get_default_standard_extensions(use_mathjax=False)[source][source]

Returns a list of standard extensions.

Parameters

use_mathjax – use mathjax or imgmath

Returns

list of standard extension.

source on GitHub