module helpgen.default_conf

Short summary

module pyquickhelper.helpgen.default_conf

Default values for the Sphinx configuration.

source on GitHub

Functions

function

truncated documentation

_skip

To skip some functions, see Skipping members.

custom_setup

See Sphinx core events.

get_default_javascript

Returns the style of additional style sheets

get_default_stylesheet

Returns the style of additional style sheets.

get_epkg_dictionary

Returns default dictionary for extension epkg_role().

get_first_line

Expects to find a text file with a line, the function extracts and returns this line.

latex_preamble

Default latex preamble.

set_sphinx_variables

Defines variables for Sphinx.

Documentation

Default values for the Sphinx configuration.

source on GitHub

pyquickhelper.helpgen.default_conf._skip(app, what, name, obj, skip, options)[source][source]

To skip some functions, see Skipping members.

source on GitHub

pyquickhelper.helpgen.default_conf.custom_setup(app, author)[source][source]

See Sphinx core events.

source on GitHub

pyquickhelper.helpgen.default_conf.get_default_javascript()[source][source]

Returns the style of additional style sheets

Returns

list of files

source on GitHub

pyquickhelper.helpgen.default_conf.get_default_stylesheet()[source][source]

Returns the style of additional style sheets.

Returns

list of files

source on GitHub

pyquickhelper.helpgen.default_conf.get_epkg_dictionary()[source][source]

Returns default dictionary for extension epkg_role.

source on GitHub

pyquickhelper.helpgen.default_conf.get_first_line(filename)[source][source]

Expects to find a text file with a line, the function extracts and returns this line.

source on GitHub

pyquickhelper.helpgen.default_conf.latex_preamble()[source][source]

Default latex preamble.

source on GitHub

pyquickhelper.helpgen.default_conf.set_sphinx_variables(fileconf, module_name, author, year, theme, theme_path, ext_locals, add_extensions=None, bootswatch_theme='spacelab', bootswatch_navbar_links=None, description_latex='', use_mathjax=False, use_lunrsearch=False, enable_disabled_parts='enable_disabled_documented_pieces_of_code', sharepost='facebook-linkedin-twitter-20-body', custom_style=None, extlinks=None, github_user=None, github_repo=None, title=None, book=True, link_resolve=None, nblayout='classic', doc_version=None)[source][source]

Defines variables for Sphinx.

Parameters
  • fileconf – location of the configuration file

  • module_name – name of the module

  • author – author

  • year – year

  • theme – theme to use

  • theme_path – theme path (sets html_theme_path)

  • ext_locals – context (see locals)

  • add_extensions – additional extensions

  • bootswatch_theme – for example, spacelab, look at spacelab

  • bootswatch_navbar_links – see sphinx-bootstrap-theme

  • description_latex – description latex

  • use_mathjax – set up the documentation to use mathjax, see sphinx.ext.mathjax, default option is True

  • use_lunrsearch – suggest autocompletion in sphinx, see sphinxcontrib-lunrsearch

  • enable_disabled_partsremove_undesired_part_for_documentation

  • sharepost – add share button to share blog post on usual networks

  • custom_style – custom style sheet

  • extlinks – parameter extlinks, example: {'issue': ('https://github.com/sdpython/pyquickhelper/issues/%s', 'issue ')}

  • github_user – git(hub) user

  • github_repo – git(hub) project

  • title – if not None, use title instead of module_name as a title

  • book – the output is a book

  • link_resolve – url where the documentation is published, used for parameter linkcode_resolve

  • nblayout'classic' or 'table', specifies the layout for the notebook gallery

  • doc_version – if not None, overwrites the current version

If the parameter custom_style is not None, it will call app.add_css_file(custom_style) in the setup.

Simple configuration file for Sphinx

We assume a module is configurated using the same structure as pyquickhelper. The file conf.py could just contain:

# -*- coding: utf-8 -*-
import sys, os, datetime, re
import solar_theme
from pyquickhelper.helpgen.default_conf import set_sphinx_variables

sys.path.insert(0, os.path.abspath(os.path.join(os.path.split(__file__)[0])))
set_sphinx_variables(__file__, "pyquickhelper", "Xavier Dupré", 2014,
                     "solar_theme", solar_theme.theme_path, locals())

# custom settings
...

setup.py must contain a string such as __version__ = 3.4. Close to the setup, there must be a file version.txt. You overwrite a value by giving a variable another value after the fucntion is called.

Some parts of the code can be disabled before generating the documentation. Those parts are surrounded by:

# -- HELP BEGIN EXCLUDE --
import module
# -- HELP END EXCLUDE --

If enable_disabled_parts is set to a string, these sections will become:

# -- HELP BEGIN EXCLUDE --
if hasattr(sys, <enable_disabled_parts>) and sys.<enable_disabled_parts>:
    import module
# -- HELP END EXCLUDE --

This example shows what variables this functions sets.

<<<

import sphinx_readable_theme
from pyquickhelper.helpgen.default_conf import set_sphinx_variables

import pyquickhelper  # replace by your module

ext_locals = {}
set_sphinx_variables("this_file_conf.py",
                     "pyquickhelper",  # replace by your module
                     "module_author", 2019,
                     "readable", sphinx_readable_theme.get_html_theme_path(),
                     ext_locals, extlinks=dict(
                         issue=('https://github.com/sdpython/module_name/issues/%s', 'issue')),
                     title="module_name")

import pprint
pprint.pprint(ext_locals)

>>>

    /var/lib/jenkins/workspace/pyquickhelper/pyquickhelper_UT_37_std/_doc/sphinxdoc/source/pyquickhelper/helpgen/default_conf.py:385: UserWarning: File 'somewhere/workspace/pyquickhelper/pyquickhelper_UT_37_std/_doc/sphinxdoc/../../../version.txt' must contain the commit number (or last part of the version).
      version_file), UserWarning)
    {'add_extensions': None,
     'author': 'module_author',
     'auto_rst_generation': True,
     'autoclass_content': 'both',
     'autosummary_generate': True,
     'backreferences_dir': 'modules/generated',
     'blocref_include_blocrefs': True,
     'blog_background': True,
     'blog_background_page': False,
     'book': True,
     'bootswatch_navbar_links': None,
     'bootswatch_theme': 'spacelab',
     'check_ie_layout_html': False,
     'copyright': '2019, module_author',
     'custom_latex_processing': None,
     'custom_style': None,
     'description_latex': '',
     'dirconf': 'somewhere/workspace/pyquickhelper/pyquickhelper_UT_37_std/_doc/sphinxdoc',
     'dirname': '',
     'doc_version': None,
     'enable_disabled_parts': 'enable_disabled_documented_pieces_of_code',
     'epkg_dictionary': {'*py': ('https://docs.python.org/3/',
                                 ('https://docs.python.org/3/library/{0}.html', 1),
                                 ('https://docs.python.org/3/library/{0}.html#{0}.{1}',
                                  2),
                                 ('https://docs.python.org/3/library/{0}.html#{0}.{1}.{2}',
                                  3)),
                         '*pyf': (('https://docs.python.org/3/library/functions.html#{0}',
                                   1),),
                         '7z': 'http://www.7-zip.org/',
                         'ASCII': 'https://en.wikipedia.org/wiki/ASCII',
                         'Anaconda': 'http://continuum.io/downloads',
                         'Azure Pipelines': 'https://azure.microsoft.com/en-us/services/devops/pipelines/',
                         'C++': 'https://en.wikipedia.org/wiki/C%2B%2B',
                         'Cython': 'http://cython.org/',
                         'DOT': 'https://www.graphviz.org/doc/info/lang.html',
                         'FTP': 'https://en.wikipedia.org/wiki/File_Transfer_Protocol',
                         'GIT': 'http://git-scm.com/',
                         'Git': 'http://git-scm.com/',
                         'GitHub': 'https://github.com/',
                         'GraphViz': 'http://www.graphviz.org/',
                         'Graphviz': 'http://www.graphviz.org/',
                         'HTML': 'https://en.wikipedia.org/wiki/HTML',
                         'IPython': 'https://en.wikipedia.org/wiki/IPython',
                         'InkScape': 'https://inkscape.org/',
                         'Inkscape': 'https://inkscape.org/',
                         'JSON': 'https://en.wikipedia.org/wiki/JSON',
                         'Java': 'http://www.java.com/fr/download/',
                         'Jenkins': 'https://jenkins-ci.org/',
                         'Jupyter': 'http://jupyter.org/',
                         'Jupyter Lab': 'https://jupyterlab.readthedocs.io/en/stable/',
                         'JupyterLab': 'https://jupyterlab.readthedocs.io/en/stable/',
                         'LaTeX': 'https://en.wikipedia.org/wiki/LaTeX',
                         'LaTex': 'https://en.wikipedia.org/wiki/LaTeX',
                         'Latex': 'https://en.wikipedia.org/wiki/LaTeX',
                         'Linux': 'https://en.wikipedia.org/wiki/Linux',
                         'MD': 'https://en.wikipedia.org/wiki/Markdown',
                         'Markdown': 'https://en.wikipedia.org/wiki/Markdown',
                         'MiKTeX': 'http://miktex.org/',
                         'Miktex': 'http://miktex.org/',
                         'MinGW': 'http://www.mingw.org/',
                         'MyBinder': 'https://gke.mybinder.org/',
                         'PEP8': 'https://www.python.org/dev/peps/pep-0008/',
                         'PEP8 codes': 'http://pep8.readthedocs.io/en/latest/intro.html#error-codes',
                         'PIL': 'http://pillow.readthedocs.io/',
                         'PNG': 'https://fr.wikipedia.org/wiki/Portable_Network_Graphics',
                         'Pandoc': 'http://johnmacfarlane.net/pandoc/',
                         'Pillow': 'http://pillow.readthedocs.io/',
                         'PyPI': 'https://pypi.org/project/',
                         'Python': 'http://www.python.org/',
                         'RST': 'https://en.wikipedia.org/wiki/ReStructuredText',
                         'SFTP': 'https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol',
                         'SVG': 'https://fr.wikipedia.org/wiki/Scalable_Vector_Graphics',
                         'SVN': 'https://subversion.apache.org/',
                         'SciTe': 'https://www.scintilla.org/SciTE.html',
                         'Sphinx': 'http://www.sphinx-doc.org/en/stable/',
                         'Sphinx application': 'http://www.sphinx-doc.org/en/stable/_modules/sphinx/application.html',
                         'TexnicCenter': 'http://www.texniccenter.org/',
                         'TortoiseSVN': 'http://tortoisesvn.net/',
                         'Visual Studio Community Edition 2015': 'https://imagine.microsoft.com/en-us/Catalog/Product/101',
                         'Windows': 'https://en.wikipedia.org/wiki/Microsoft_Windows',
                         'YAML': 'https://en.wikipedia.org/wiki/YAML',
                         'appveyor': 'https://www.appveyor.com/',
                         'autopep8': 'https://github.com/hhatto/autopep8',
                         'azure pipeline': 'https://azure.microsoft.com/en-us/services/devops/pipelines/',
                         'azure pipelines': 'https://azure.microsoft.com/en-us/services/devops/pipelines/',
                         'bokeh': 'https://bokeh.pydata.org/en/latest/',
                         'builderapi': 'http://www.sphinx-doc.org/en/stable/extdev/builderapi.html',
                         'bz2': 'https://en.wikipedia.org/wiki/Bzip2',
                         'cairosvg': 'https://github.com/Kozea/CairoSVG',
                         'chrome': 'https://www.google.com/chrome/',
                         'circleci': 'https://circleci.com/',
                         'class Sphinx': 'https://github.com/sphinx-doc/sphinx/blob/master/sphinx/application.py#L107',
                         'codecov': 'https://codecov.io/',
                         'conda': 'https://github.com/conda/conda',
                         'coverage': 'https://pypi.org/project/coverage',
                         'cryptography': 'http://cryptography.readthedocs.org/',
                         'cssselect2': 'http://cssselect2.readthedocs.io/en/latest/',
                         'dataframe': 'https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html',
                         'datetime': 'https://docs.python.org/3/library/datetime.html#datetime-objects',
                         'datetime.datetime.strptime': 'https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior',
                         'django': 'https://www.djangoproject.com/',
                         'docutils': 'http://docutils.sourceforge.net/',
                         'docx': 'https://en.wikipedia.org/wiki/Office_Open_XML',
                         'doxygen': 'http://www.doxygen.org/',
                         'dvipng': 'https://ctan.org/pkg/dvipng?lang=en',
                         'format style': 'https://pyformat.info/>`_',
                         'getsitepackages': 'https://docs.python.org/3/library/site.html#site.getsitepackages',
                         'git': 'http://git-scm.com/',
                         'github': 'https://github.com/',
                         'graphviz': 'http://www.graphviz.org/',
                         'html': 'https://en.wikipedia.org/wiki/HTML',
                         'imgmath': 'http://www.sphinx-doc.org/en/master/usage/extensions/math.html#module-sphinx.ext.imgmath',
                         'javascript': 'https://en.wikipedia.org/wiki/JavaScript',
                         'jinja2': 'http://jinja.pocoo.org/docs/',
                         'js2py': 'https://github.com/PiotrDabkowski/Js2Py',
                         'json': 'https://docs.python.org/3/library/json.html',
                         'jupyter': 'http://jupyter.org/',
                         'jupyter_sphinx': 'https://jupyter-sphinx.readthedocs.io/en/latest/index.html',
                         'jyquickhelper': 'http://www.xavierdupre.fr/app/jyquickhelper/helpsphinx/index.html',
                         'latex': 'https://en.wikipedia.org/wiki/LaTeX',
                         'linux': 'https://en.wikipedia.org/wiki/Linux',
                         'mako': 'http://www.makotemplates.org/',
                         'markdown': 'https://en.wikipedia.org/wiki/Markdown',
                         'mathjax': 'https://www.mathjax.org/',
                         'matplotlib': 'https://matplotlib.org/index.html',
                         'md': 'https://en.wikipedia.org/wiki/Markdown',
                         'miktex': 'http://miktex.org/',
                         'mistune': 'https://pypi.org/project/mistune',
                         'nbconvert': 'http://nbconvert.readthedocs.io/en/latest/',
                         'nbpresent': 'https://github.com/Anaconda-Platform/nbpresent',
                         'node.js': 'https://nodejs.org/en/',
                         'nose': 'https://pypi.org/project/nose',
                         'notebook': 'https://jupyter-notebook.readthedocs.io/',
                         'npm': 'https://www.npmjs.com/',
                         'numpy': ('http://www.numpy.org/',
                                   ('http://docs.scipy.org/doc/numpy/reference/generated/numpy.{0}.html',
                                    1),
                                   ('http://docs.scipy.org/doc/numpy/reference/generated/numpy.{0}.{1}.html',
                                    2)),
                         'pandas': ('http://pandas.pydata.org/pandas-docs/stable/',
                                    ('http://pandas.pydata.org/pandas-docs/stable/generated/pandas.{0}.html',
                                     1),
                                    ('http://pandas.pydata.org/pandas-docs/stable/generated/pandas.{0}.{1}.html',
                                     2)),
                         'pandoc': 'http://johnmacfarlane.net/pandoc/',
                         'paramiko': 'http://www.paramiko.org/',
                         'pdf': 'https://en.wikipedia.org/wiki/Portable_Document_Format',
                         'pep8': 'https://www.python.org/dev/peps/pep-0008/',
                         'pip': 'https://pip.pypa.io/en/stable/',
                         'png': 'https://fr.wikipedia.org/wiki/Portable_Network_Graphics',
                         'pycodestyle': 'http://pycodestyle.readthedocs.io/',
                         'pycrypto': 'https://pypi.org/project/pycrypto',
                         'pycryptodome': 'https://pypi.org/project/pycryptodome/',
                         'pycryptodomex': 'https://pypi.org/project/pycryptodomex/',
                         'pyformat.info': 'https://pyformat.info/>`_',
                         'pygments': 'http://pygments.org/',
                         'pyinstrument': 'https://github.com/joerick/pyinstrument',
                         'pylint': 'https://www.pylint.org/',
                         'pylint error codes': 'http://pylint-messages.wikidot.com/all-codes',
                         'pylzma': 'https://pypi.org/project/pylzma',
                         'pymyinstall': 'http://www.xavierdupre.fr/app/pymyinstall/helpsphinx/index.html',
                         'pypi': 'https://pypi.org/project/',
                         'pyquickhelper': 'http://www.xavierdupre.fr/app/pyquickhelper/helpsphinx/index.html',
                         'pyrsslocal': 'http://www.xavierdupre.fr/app/pyrsslocal/helpsphinx/index.html',
                         'pysftp': 'https://pysftp.readthedocs.io/',
                         'pytest': 'https://docs.pytest.org/en/latest/',
                         'python': 'http://www.python.org/',
                         'python-jenkins': 'http://python-jenkins.readthedocs.org/en/latest/',
                         'pywin32': 'https://sourceforge.net/projects/pywin32/',
                         'reveal.js': 'https://github.com/hakimel/reveal.js/releases',
                         'rst': 'https://en.wikipedia.org/wiki/ReStructuredText',
                         'scikit-learn': 'http://scikit-learn.org/',
                         'scipy': 'https://www.scipy.org/',
                         'sklearn': ('http://scikit-learn.org/stable/',
                                     ('http://scikit-learn.org/stable/modules/generated/{0}.html',
                                      1),
                                     ('http://scikit-learn.org/stable/modules/generated/{0}.{1}.html',
                                      2)),
                         'sphinx': 'http://www.sphinx-doc.org/en/stable/',
                         'sphinx-gallery': 'https://sphinx-gallery.readthedocs.io/en/latest/',
                         'sphinx.ext.autodoc': 'http://www.sphinx-doc.org/en/stable/ext/autodoc.html#module-sphinx.ext.autodoc',
                         'svg': 'https://fr.wikipedia.org/wiki/Scalable_Vector_Graphics',
                         'svn': 'https://subversion.apache.org/',
                         'tar.gz': 'https://en.wikipedia.org/wiki/Tar_(computing)',
                         'tinycss2': 'http://pythonhosted.org/tinycss2/',
                         'tkinter': 'https://docs.python.org/3/library/tkinter.html',
                         'tkinterquickhelper': 'http://www.xavierdupre.fr/app/tkinterquickhelper/helpsphinx/index.html',
                         'toctree': 'http://www.sphinx-doc.org/en/stable/markup/toctree.html',
                         'tornado': 'http://www.tornadoweb.org/en/stable/',
                         'travis': 'https://travis-ci.org/',
                         'vis.js': 'https://visjs.org/',
                         'viz.js': 'https://github.com/mdaines/viz.js/',
                         'xml': 'https://docs.python.org/3/library/xml.etree.elementtree.html#module-xml.etree.ElementTree',
                         'yaml': 'https://en.wikipedia.org/wiki/YAML',
                         'yml': 'https://en.wikipedia.org/wiki/YAML',
                         'zip': 'https://en.wikipedia.org/wiki/Zip_(file_format)'},
     'exa': '../../../_doc/examples',
     'exclude_patterns': ['*.py', '**/*.py'],
     'exref_include_exrefs': True,
     'extensions': ['sphinx.ext.autodoc',
                    'sphinx.ext.autosummary',
                    'sphinx.ext.coverage',
                    'sphinx.ext.extlinks',
                    'sphinx.ext.graphviz',
                    'sphinx.ext.ifconfig',
                    'sphinx.ext.inheritance_diagram',
                    'sphinx.ext.imgmath',
                    'sphinx.ext.napoleon',
                    'sphinx.ext.todo',
                    'sphinx.ext.viewcode',
                    'sphinxcontrib.imagesvg',
                    'jupyter_sphinx.execute',
                    'pyquickhelper.sphinxext.sphinx_rst_builder',
                    'pyquickhelper.sphinxext.sphinx_md_builder',
                    'pyquickhelper.sphinxext.sphinx_latex_builder',
                    'matplotlib.sphinxext.plot_directive',
                    'sphinxcontrib.jsdemo'],
     'extlinks': {'issue': ('https://github.com/sdpython/module_name/issues/%s',
                            'issue')},
     'faqref_include_faqrefs': True,
     'fileconf': 'this_file_conf.py',
     'find_dvipng_path': <function find_dvipng_path at 0x7f34b5e6cbf8>,
     'find_graphviz_dot': <function find_graphviz_dot at 0x7f34b5e6c9d8>,
     'first_line': '0',
     'github_repo': 'https://github.com/sdpython/module_name.git',
     'github_user': None,
     'githublink_options': {'anchor': 'source on GitHub',
                            'project': 'module_name',
                            'user': 'sdpython'},
     'graphviz_dot': 'dot',
     'graphviz_output_format': 'svg',
     'has_sphinx_gallery': True,
     'html_favicon': 'phdoc_static/project_ico.ico',
     'html_last_updated_fmt': '2019-10-14',
     'html_logo': 'phdoc_static/project_ico.png',
     'html_output_encoding': 'utf-8',
     'html_show_copyright': False,
     'html_show_sphinx': False,
     'html_sidebars': {'[!blog]**': ['searchbox.html',
                                     'moduletoc.html',
                                     'relations.html',
                                     'sourcelink.html'],
                       'blog/**': ['searchbox.html',
                                   'blogtoc.html',
                                   'localtoc.html',
                                   'sourcelink.html']},
     'html_static_path': ['phdoc_static'],
     'html_theme': 'readable',
     'html_theme_path': ['/usr/local/lib/python3.7/site-packages/sphinx_readable_theme'],
     'html_title': 'module_name',
     'htmlhelp_basename': 'pyquickhelper_doc',
     'imgmath_dvipng': 'dvipng',
     'imgmath_dvisvgm': 'dvisvgm',
     'imgmath_image_format': 'svg',
     'imgmath_latex': 'latex',
     'imgmath_latex_preamble': '\n'
                               '                    %% addition by '
                               'pyquickhelper(2) %%\n'
                               '                    \\usepackage{epic}\n'
                               '                    '
                               '\\newcommand{\\acc}[1]{\\left\\{#1\\right\\}}\n'
                               '                    '
                               '\\newcommand{\\cro}[1]{\\left[#1\\right]}\n'
                               '                    '
                               '\\newcommand{\\pa}[1]{\\left(#1\\right)}\n'
                               '                    '
                               '\\newcommand{\\R}{\\mathbb{R}}\n'
                               '                    %% addition by '
                               'pyquickhelper(2) %%\n'
                               '                    ',
     'intersphinx_mapping': {'matplotlib': ('http://matplotlib.org/', None),
                             'numpy': ('http://www.numpy.org/1.17.2', None),
                             'pandas': ('http://pandas.pydata.org/pandas-docs/version/0.25.1',
                                        None),
                             'python': ('https://docs.python.org/3.7', None)},
     'issue': ['https:',
               '',
               'github.com',
               'sdpython',
               'module_name',
               'issues',
               '%s'],
     'jupyter_sphinx_thebelab_config': {'requestKernel': True},
     'language': 'en',
     'latex_book': True,
     'latex_documents': [('index',
                          'pyquickhelper_doc.tex',
                          'module_name',
                          'module_author',
                          'manual',
                          True)],
     'latex_elements': {'papersize': 'a4',
                        'pointsize': '10pt',
                        'preamble': '\n'
                                    '%% addition by pyquickhelper(1) %%\n'
                                    '\\usepackage{etex}\n'
                                    '\\usepackage{fixltx2e} % LaTeX patches, '
                                    '\\textsubscript\n'
                                    '\\usepackage{cmap} % fix search and '
                                    'cut-and-paste in Acrobat\n'
                                    '\\usepackage[raccourcis]{fast-diagram}\n'
                                    '\\usepackage{titlesec}\n'
                                    '\\usepackage{amsmath}\n'
                                    '\\usepackage{amssymb}\n'
                                    '\\usepackage{amsfonts}\n'
                                    '\\usepackage{graphics}\n'
                                    '\\usepackage{epic}\n'
                                    '\\usepackage{eepic}\n'
                                    '\\usepackage{media9}\n'
                                    '%\\usepackage{pict2e}\n'
                                    '%%% Redefined titleformat\n'
                                    '\\setlength{\\parindent}{0cm}\n'
                                    '\\setlength{\\parskip}{1ex plus 0.5ex minus '
                                    '0.2ex}\n'
                                    '\\newcommand{\\hsp}{\\hspace{20pt}}\n'
                                    '\\newcommand{\\acc}[1]{\\left\\{#1\\right\\}}\n'
                                    '\\newcommand{\\cro}[1]{\\left[#1\\right]}\n'
                                    '\\newcommand{\\pa}[1]{\\left(#1\\right)}\n'
                                    '\\newcommand{\\R}{\\mathbb{R}}\n'
                                    '\\newcommand{\\HRule}{\\rule{\\linewidth}{0.5mm}}\n'
                                    '%\\titleformat{\\chapter}[hang]{\\Huge\\bfseries\\sffamily}{\\thechapter\\hsp}{0pt}{\\Huge\\bfseries\\sffamily}\n'
                                    '\n'
                                    '\\renewcommand{\\Verbatim}[1][1]{%\n'
                                    '\\bgroup\\parskip=0pt%\n'
                                    '\\smallskip%\n'
                                    '\\list{}{%\n'
                                    '    \\setlength\\parskip{0pt}%\n'
                                    '    \\setlength\\itemsep{0ex}%\n'
                                    '    \\setlength\\topsep{0ex}%\n'
                                    '    \\setlength\\partopsep{0pt}%\n'
                                    '    \\setlength\\leftmargin{10pt}%\n'
                                    '}%\n'
                                    '\\item\\MakeFramed{\\FrameRestore}%\n'
                                    '\\tiny\n'
                                    '\\OriginalVerbatim[#1]%\n'
                                    '%% addition by pyquickhelper(1) %%\n'
                                    '}\n'},
     'latex_show_pagerefs': True,
     'latex_show_urls': 'footnote',
     'latex_use_parts': False,
     'le': 7,
     'link_resolve': None,
     'linkcode_resolve_function': <function set_sphinx_variables.<locals>.linkcode_resolve_function at 0x7f347f8a02f0>,
     'man_pages': [('index',
                    'pyquickhelper_doc',
                    'module_name',
                    ['module_author'],
                    1)],
     'master_doc': 'index',
     'math_number_all': False,
     'mathdef_include_mathsext': True,
     'mathdef_link_number': '{first_letter}{number}',
     'matplotlib': <module 'matplotlib' from '/usr/local/lib/python3.7/site-packages/matplotlib/__init__.py'>,
     'mod': <module 'pyquickhelper' from 'somewhere/workspace/pyquickhelper/pyquickhelper_UT_37_std/_doc/sphinxdoc/source/pyquickhelper/__init__.py'>,
     'modify_commit': <function set_sphinx_variables.<locals>.modify_commit_function at 0x7f347f8a0378>,
     'modify_commit_function': <function set_sphinx_variables.<locals>.modify_commit_function at 0x7f347f8a0378>,
     'modindex_common_prefix': ['pyquickhelper.'],
     'module_name': 'pyquickhelper',
     'nblayout': 'classic',
     'nbref_include_nbrefs': True,
     'notebook_custom_snippet_folder': 'notebooks_snippets',
     'notebook_replacements': {'html': [('\\mathbb{1}_', '\\mathbf{1\\!\\!1}_')]},
     'numfig': False,
     'numpy': <module 'numpy' from '/usr/local/lib/python3.7/site-packages/numpy/__init__.py'>,
     'pandas': <module 'pandas' from '/usr/local/lib/python3.7/site-packages/pandas/__init__.py'>,
     'plot_html_show_source_link': False,
     'plot_include_source': True,
     'preamble': '\n'
                 '%% addition by pyquickhelper(1) %%\n'
                 '\\usepackage{etex}\n'
                 '\\usepackage{fixltx2e} % LaTeX patches, \\textsubscript\n'
                 '\\usepackage{cmap} % fix search and cut-and-paste in Acrobat\n'
                 '\\usepackage[raccourcis]{fast-diagram}\n'
                 '\\usepackage{titlesec}\n'
                 '\\usepackage{amsmath}\n'
                 '\\usepackage{amssymb}\n'
                 '\\usepackage{amsfonts}\n'
                 '\\usepackage{graphics}\n'
                 '\\usepackage{epic}\n'
                 '\\usepackage{eepic}\n'
                 '\\usepackage{media9}\n'
                 '%\\usepackage{pict2e}\n'
                 '%%% Redefined titleformat\n'
                 '\\setlength{\\parindent}{0cm}\n'
                 '\\setlength{\\parskip}{1ex plus 0.5ex minus 0.2ex}\n'
                 '\\newcommand{\\hsp}{\\hspace{20pt}}\n'
                 '\\newcommand{\\acc}[1]{\\left\\{#1\\right\\}}\n'
                 '\\newcommand{\\cro}[1]{\\left[#1\\right]}\n'
                 '\\newcommand{\\pa}[1]{\\left(#1\\right)}\n'
                 '\\newcommand{\\R}{\\mathbb{R}}\n'
                 '\\newcommand{\\HRule}{\\rule{\\linewidth}{0.5mm}}\n'
                 '%\\titleformat{\\chapter}[hang]{\\Huge\\bfseries\\sffamily}{\\thechapter\\hsp}{0pt}{\\Huge\\bfseries\\sffamily}\n'
                 '\n'
                 '\\renewcommand{\\Verbatim}[1][1]{%\n'
                 '\\bgroup\\parskip=0pt%\n'
                 '\\smallskip%\n'
                 '\\list{}{%\n'
                 '    \\setlength\\parskip{0pt}%\n'
                 '    \\setlength\\itemsep{0ex}%\n'
                 '    \\setlength\\topsep{0ex}%\n'
                 '    \\setlength\\partopsep{0pt}%\n'
                 '    \\setlength\\leftmargin{10pt}%\n'
                 '}%\n'
                 '\\item\\MakeFramed{\\FrameRestore}%\n'
                 '\\tiny\n'
                 '\\OriginalVerbatim[#1]%\n'
                 '%% addition by pyquickhelper(1) %%\n'
                 '}\n',
     'project': 'module_name',
     'project_var_name': 'pyquickhelper',
     'pygments_style': 'sphinx',
     'python_link_doc': <function python_link_doc at 0x7f34a7e64048>,
     'release': '1.9.0',
     'setup': <function set_sphinx_variables.<locals>.this_setup at 0x7f347f8a0400>,
     'sharepost': 'facebook-linkedin-twitter-20-body',
     'shtml_theme_options': {'bodyfont': 'Calibri'},
     'skipset': {'sphinx_gallery.gen_gallery'},
     'source_encoding': 'utf-8',
     'source_suffix': '.rst',
     'sphinx_gallery': <module 'sphinx_gallery' from '/usr/local/lib/python3.7/site-packages/sphinx_gallery/__init__.py'>,
     'sphinxcontrib': <module 'sphinxcontrib' (namespace)>,
     'templates_path': ['phdoc_templates'],
     'texinfo_documents': [('index',
                            'module_name',
                            'module_name',
                            'module_author',
                            'module_name',
                            '',
                            'Miscellaneous')],
     'theme': 'readable',
     'theme_path': '/usr/local/lib/python3.7/site-packages/sphinx_readable_theme',
     'title': 'module_name',
     'todo_include_todos': True,
     'todoext_include_todosext': True,
     'tpl_template': {'py': <function python_link_doc at 0x7f34a7e64048>},
     'use_lunrsearch': False,
     'use_mathjax': False,
     'user': 'sdpython',
     'version': '1.9',
     'version_file': 'somewhere/workspace/pyquickhelper/pyquickhelper_UT_37_std/_doc/sphinxdoc/../../../version.txt',
     'viewcode_follow_imported_members': True,
     'year': '2019'}

Changed in version 1.9: Uses jupyter_sphinx>=0.2.

source on GitHub