使用Markdown而非reStructuredText的PyScaffold扩展
项目描述
pyscaffoldext-markdown
PyScaffold 扩展，用 reStructuredText 格式的文件替换 Markdown 格式（通过 MyST 实现），除非是 Sphinx 相关文件。
使用方法
只需使用以下任一命令安装此软件包：pip install pyscaffoldext-markdown 或 conda install -c conda-forge pyscaffoldext-markdown。注意，putup -h 命令会显示新的选项 --markdown。基本来说，这个扩展会将 README.rst 替换为正确的 README.md 并激活 Sphinx 对 Markdown 文件的支持。
构建和发布
默认情况下，由 PyScaffold 生成的 tox 配置与 Markdown 兼容（如本扩展实现的那样）。这意味着（在用 pip 或 pipx 安装 tox 之后）你可以运行
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
请记住，命令 python setup.py release 已不再推荐使用，所以如果你不喜欢 tox，请考虑直接使用 Sphinx 和 twine。
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
修改代码及贡献
本项目使用 pre-commit，请在修改任何代码之前确保已安装它。
pip install pre-commit
cd pyscaffoldext-markdown
pre-commit install
更新钩子到最新版本是个好主意。
pre-commit autoupdate
请参阅 PyScaffold 的 贡献指南。
注意
本项目使用 PyScaffold 4.0 进行设置。有关 PyScaffold 的详细信息和使用信息，请参阅 https://pyscaffold.org/。
下载文件
请下载适合您平台的文件。如果您不确定选择哪个，请了解更多关于 安装软件包 的信息。
源代码发行版
pyscaffoldext-markdown-0.5.tar.gz (29.6 kB 查看哈希值)
构建发行版
关闭
哈希值 for pyscaffoldext_markdown-0.5-py2.py3-none-any.whl
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | a6ed064163fc0ec47f224c0bb5315b261fa41d49fd566dada48e21e8baab0e65 |
|
| MD5 | f1944a848fd4cadbc0deb7c60eaf6cdc |
|
| BLAKE2b-256 | 55ec866bdedd05fab16282a30ea91ab1b4b2cfee5bd3cec7745e298de267d69d |