PyScaffold extension which replaces reStructuredText by Markdown
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
src/pyscaffoldext
tests
.coveragerc
.gitignore
AUTHORS.rst
CHANGELOG.rst
LICENSE.txt
README.md
requirements.txt
setup.cfg
setup.py

README.md

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/*

Note

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