Metadata-Version: 2.1
Name: sphinxcontrib-commonmark
Version: 0.1.0
Summary: Yet another commonmark processor for Sphinx
Home-page: https://github.com/tk0miya/sphinxcontrib-commonmark/
Author: Takeshi KOMIYA
Author-email: i.tkomiya@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Framework :: Sphinx :: Extension
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Utilities
Description-Content-Type: text/markdown
Requires-Dist: Sphinx (>=2.0)
Requires-Dist: pycmark
Provides-Extra: test
Requires-Dist: tox ; extra == 'test'
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: flake8-import-order ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: mypy ; extra == 'test'

# 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.


