Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

PyScaffold extension which uses Markdown instead of reStructuredText

Project description

Build Status ReadTheDocs Coveralls PyPI-Server Conda-Forge Downloads

pyscaffoldext-markdown

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

Usage

Just install this package with either pip install pyscaffoldext-markdown or conda install -c conda-forge 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.

Limitations

Due to limitations of the Markdown syntax compared to reStructuredText, it is necessary to use symbolic links (and some reStructuredText files) to avoid keeping multiple copies of files (such as CHANGELOG.md) meant to be placed at the root of the repository but included in the documentation generated by Sphinx. If you are a Windows user please make sure to configure your system accordingly. The following references might be helpful:

Symbolic links on Windows

Markdown limitations

Windows users that still face problems after configuring their systems for symbolic links might want to attempt WSL or decide to stick with reStructuredText for (problematic) parts of their documentation files.

Building and Releasing

By default, the tox configuration generated by PyScaffold is compatible with Markdown (as implemented in this extension). This means that (after installing tox with pip or pipx) you can run:

tox -e docs  # to build your documentation
tox -e build  # to build your package distribution
tox -e publish  # to test your project uploads correctly in test.pypi.org
tox -e publish -- --repository pypi  # to release your package to PyPI
tox -av  # to list all the tasks available

Please remember that the command python setup.py release is no longer recommended, so if you don't like tox, please consider using Sphinx and twine directly:

python -m pip install -U pip setuptools wheel sphinx twine
python setup.py bdist_wheel  # to build your package distributions
make -C docs html  # to build your docs
twine upload dist/*  # to release your package to PyPI

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 4.0. 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.4.1
Filename, size File type Python version Upload date Hashes
Filename, size pyscaffoldext_markdown-0.4.1-py2.py3-none-any.whl (11.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size pyscaffoldext-markdown-0.4.1.tar.gz (25.8 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page