Skip to main content

PyScaffold extension which replaces reStructuredText by Markdown

Project description

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

Project details


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
pyscaffoldext_markdown-0.2.1-py2.py3-none-any.whl (6.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page