Skip to content

peter1000/convert_md_2_rst

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 

Repository files navigation

convert_md_2_rst

Convert Markdown to reStructuredText extension for Sphinx Doc

Scans for '.md' files and converts them to '.rst' files using pandoc.

For use it just copy the file 'convert_md_2_rst.py' to your source directory and add 'convert_md_2_rst' to the 'extensions' value of your 'conf.py' file.

Ensure that the source path is in the Python sys path. For that purpose you may add this line to 'conf.py':

sys.path.insert(0, os.path.abspath('.'))

IMPORTANT: The code assumes that you use the folder 'source' for your Sphinx Doc files. If different, just change it in the 'convert_md_2_rst.py' file.

For converting docstrings Markdown to reStructuredText you may use @embolalia extension Sphinx-Pandoc.

Thanks to @embolalia for the inspiration and source code reference for this extension.

About

A simple Sphinx Doc extension to convert Markdown files to ReStrucTured documents

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%