module cli.simplified_fct

Short summary

module pyquickhelper.cli.simplified_fct

Simplified function versions.

source on GitHub

Functions

function

truncated documentation

sphinx_rst

Converts a string from RST to HTML to RST format.

Documentation

Simplified function versions.

source on GitHub

pyquickhelper.cli.simplified_fct.sphinx_rst(input='', writer='html', keep_warnings=False, directives=None, language='en', layout='sphinx', output='output')[source][source]

Converts a string from RST to HTML to RST format.

Parameters
  • input – text of filename

  • writer'html' for HTML format, 'rst' for RST format, 'md' for MD format, 'elatex' for latex format, 'doctree' to get the doctree, writer can also be a tuple for custom formats and must be like ('buider_name', builder_class).

  • keep_warnings – keep_warnings in the final HTML

  • directives – new directives to add, comma separated values

  • language – language

  • layout'docutils', 'sphinx', 'sphinx_body', see below.

  • output – document name, the function adds the extension

Returns

output

source on GitHub