PyScaffold extension which uses Markdown instead of reStructuredText
PyScaffold extension which replaces reStructuredText formatted files by Markdown format (with the help of MyST) except for Sphinx-related files.
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
Basically this extension will replace
README.rst by a proper
activate the support of Markdown files in Sphinx.
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:
Please also check PyScaffold's contribution guidelines.
This project has been set up using PyScaffold 4.0. For details and usage information on PyScaffold see https://pyscaffold.org/.
Release history Release notifications | RSS feed
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for pyscaffoldext-markdown-0.5.tar.gz
Hashes for pyscaffoldext_markdown-0.5-py2.py3-none-any.whl