Skip to main content

Yet another commonmark processor for Sphinx

Project description

sphinxcontrib-commonmark

Yet another commonmark processor for Sphinx

Install

Install the package via pip

$ pip install sphinxcontrib-commonmark

And append sphinxcontrib.commonmark to extensions list in your conf.py.

extensions = ['sphinxcontrib.commonmark']

Restrictions

  • Hard line break is only available with HTML and LaTeX builders.
  • Two or more level deeper headings are disallowed. Top level headings should be 1st level. And nested headings should be only one level deeper than its parent.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinxcontrib-commonmark-0.1.0.tar.gz (7.5 kB view hashes)

Uploaded source

Built Distributions

sphinxcontrib_commonmark-0.1.0-py3.7.egg (5.9 kB view hashes)

Uploaded 3 7

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page