hiro/recommonmark
1
0
Fork 0
mirror of https://github.com/vale981/recommonmark synced 2025-03-05 10:01:39 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #113 from tk0miya/use_new_Sphinx_API

Browse source 
Register a parser class using new Sphinx API; add_source_suffix
This commit is contained in:
Eric Holscher 2018-09-07 17:24:21 +02:00 • committed by GitHub
commit 51b7f77e13
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -24,6 +24,10 @@ pip install recommonmark
Then add this to your Sphinx conf.py: Then add this to your Sphinx conf.py:
``` ```
# for Sphinx-1.4 or newer
extensions = ['recommonmark']
# for Sphinx-1.3
from recommonmark.parser import CommonMarkParser from recommonmark.parser import CommonMarkParser
source_parsers = { source_parsers = {

9
recommonmark/__init__.py
View file

@ -5,6 +5,13 @@ __version__ = '0.4.0'
def setup(app): def setup(app):
"""Initialize Sphinx extension.""" """Initialize Sphinx extension."""
import sphinx
from .parser import CommonMarkParser from .parser import CommonMarkParser
app.add_source_parser('.md', CommonMarkParser) # needs Sphinx >= 1.4
if sphinx.version_info >= (1, 8):
app.add_source_suffix('.md', 'markdown')
app.add_source_parser(CommonMarkParser)
elif sphinx.version_info >= (1, 4):
app.add_source_parser('.md', CommonMarkParser)
return {'version': __version__, 'parallel_read_safe': True} return {'version': __version__, 'parallel_read_safe': True}