PyScaffold extension which uses Markdown instead of reStructuredText
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/*
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/.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyscaffoldext-markdown-0.4a2.tar.gz.
File metadata
- Download URL: pyscaffoldext-markdown-0.4a2.tar.gz
- Upload date:
- Size: 20.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | ad5c3788d14ea89ed04671b9b9e27288fbd39bd798b3456e450e402fb0e79b8e |
|
| MD5 | cff650ad1a5b82facd33c30782a1d67f |
|
| BLAKE2b-256 | 64a2bfea121a1c97b376c51fb9567e3b6ba74b46fa7a0f98746712e17a4533d8 |
File details
Details for the file pyscaffoldext_markdown-0.4a2-py2.py3-none-any.whl.
File metadata
- Download URL: pyscaffoldext_markdown-0.4a2-py2.py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.6.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 45aaaaa826ca48bbf31b490b90f24beaba41d2259ec38efe4511e2f63031f2e6 |
|
| MD5 | 90e47d7752461efd95bf87bde7635c05 |
|
| BLAKE2b-256 | 8c645f429f7816c6133c8deaea8f6cff61416da73c9a0d7cd6151b7f73657c31 |
