module helpgen.markdown_helper

Short summary

module pyquickhelper.helpgen.markdown_helper

Helpers for markdown functionalities, it requires dependencies on mistune.

source on GitHub

Functions

function

truncated documentation

parse_markdown

parse markdown text and return the markdown object

yield_sphinx_only_markup_for_pipy

Code from My rst README is not formatted on pypi.python.org. …

Documentation

Helpers for markdown functionalities, it requires dependencies on mistune.

source on GitHub

pyquickhelper.helpgen.markdown_helper.parse_markdown(text)[source]

parse markdown text and return the markdown object

Parameters:

text – markdown text

Returns:

source on GitHub

pyquickhelper.helpgen.markdown_helper.yield_sphinx_only_markup_for_pipy(lines)[source]

Code from My rst README is not formatted on pypi.python.org.

Parameters:

lines – lines to process

source on GitHub