Skip to main content

PyScaffold extension which uses MarkDown instead of reStructuredText

Project description

Build Status Coveralls PyPI-Server

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.2. For details and usage information on PyScaffold see https://pyscaffold.org/.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyscaffoldext-markdown, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size pyscaffoldext_markdown-0.3.2-py2.py3-none-any.whl (7.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pyscaffoldext-markdown-0.3.2.tar.gz (18.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page