pyscaffoldext-markdown 0.4b1

PyScaffold extension which uses Markdown instead of reStructuredText

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 README.rst by a proper README.md and activate the support of Markdown files in Sphinx. 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, e.g.:

python setup.py sdist bdist_wheel
twine upload dist/*

Making Changes & Contributing

This project uses pre-commit, please make sure to install it before making any changes:

pip install pre-commit
cd pyscaffoldext-markdown
pre-commit install

It is a good idea to update the hooks to the latest version:

pre-commit autoupdate

Please also check PyScaffold's contribution guidelines.

Note

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