module helpgen.sphinxm_custom_app

Inheritance diagram of pyquickhelper.helpgen.sphinxm_custom_app

Short summary

module pyquickhelper.helpgen.sphinxm_custom_app

Inspired from module sphinx-testing

source on GitHub

Classes

class

truncated documentation

CustomSphinxApp

A subclass of class Sphinx, the goal is to interpret RST with custom directives.

Properties

property

truncated documentation

_setting_up_extension

enumerable_nodes

Methods

method

truncated documentation

__init__

__str__

usual

_add_missing_element_in_config

Adds extra elements in config such as latex_elements.

cleanup

do some cleanup

Documentation

Inspired from module sphinx-testing

source on GitHub

class pyquickhelper.helpgen.sphinxm_custom_app.CustomSphinxApp(srcdir, outdir, confdir=None, doctreedir=None, buildername='html', confoverrides=None, status=None, warning=None, freshenv=False, warningiserror=False, tags=None, copy_srcdir_to_tmpdir=False, create_new_srcdir=False, cleanup_on_errors=True, verbosity=0, parallel=0, extensions='all')[source][source]

Bases: sphinx.application.Sphinx

A subclass of class Sphinx, the goal is to interpret RST with custom directives.

source on GitHub

Parameters
  • srcdir – source folder

  • outdir – output folder

  • confdir – configuration folder, default is srcdir

  • doctreedir – doc tree folder

  • buildername – HTML by default

  • confoverrides – None or dictionary

  • status – StringIO to retrieve them

  • warning – StringIO to retrieve them

  • freshenv – boolean

  • warningiserror – warning as errors?

  • tags – additional documentation

  • copy_srcdir_to_tmpdir – copy the source to a temporary directory

  • create_new_srcdir – create a new source directory

  • cleanup_on_errors – force cleanup on errors

  • verbosity – integer

  • parallel – integer (number of threads)

  • extensions – if 'all', add extensions implemented by this module, use None for an empty list, ‘extensions’ must not be in confoverrides

source on GitHub

__init__(srcdir, outdir, confdir=None, doctreedir=None, buildername='html', confoverrides=None, status=None, warning=None, freshenv=False, warningiserror=False, tags=None, copy_srcdir_to_tmpdir=False, create_new_srcdir=False, cleanup_on_errors=True, verbosity=0, parallel=0, extensions='all')[source][source]
Parameters
  • srcdir – source folder

  • outdir – output folder

  • confdir – configuration folder, default is srcdir

  • doctreedir – doc tree folder

  • buildername – HTML by default

  • confoverrides – None or dictionary

  • status – StringIO to retrieve them

  • warning – StringIO to retrieve them

  • freshenv – boolean

  • warningiserror – warning as errors?

  • tags – additional documentation

  • copy_srcdir_to_tmpdir – copy the source to a temporary directory

  • create_new_srcdir – create a new source directory

  • cleanup_on_errors – force cleanup on errors

  • verbosity – integer

  • parallel – integer (number of threads)

  • extensions – if 'all', add extensions implemented by this module, use None for an empty list, ‘extensions’ must not be in confoverrides

source on GitHub

__str__()[source][source]

usual

source on GitHub

_add_missing_element_in_config()[source][source]

Adds extra elements in config such as latex_elements.

source on GitHub

cleanup(error=None)[source][source]

do some cleanup

Parameters

error – error is an exception

source on GitHub