pyscaffoldext-markdown 0.1

PyScaffold extension which replaces reStructuredText by Markdown

pyscaffoldext-markdown

PyScaffold extension which replaces reStructuredText formatted files by Markdown format except for Sphinx-related files.

Usage

Just install this package with pip install pyscaffoldext-markdown and note that putup -h shows a new option --markdown. Basically this extension will replace all README.rst by README.md. The support of Markdown files in Sphinx will be activated. Due to limitations of the Markdown syntax compared to reStructuredText, the main documentation files still use reStructuredText by default.

Remember to install wheel version 0.31 or higher and use twine to upload your package to PyPI instead of python setup.py release for this to work, i.e.:

python setup.py sdist bdist_wheel
twine upload dist/*

Note

This project has been set up using PyScaffold 3.1rc1. For details and usage information on PyScaffold see https://pyscaffold.org/.