将RST转换为MyST-Markdown。
项目描述
rst-to-myst
将ReStructuredText转换为MyST Markdown，并探索可用的角色/指令。
查看tests/fixtures/render.txt以获取输入 -> 输出的示例。
安装
pip install rst-to-myst
或使用sphinx
pip install rst-to-myst[sphinx]
然后运行整个项目的基本转换
$ rst2myst convert docs/**/*.rst
为了更好的控制，您可以通过CLI选项或通过YAML配置文件传递配置
$ rst2myst convert --config config.yaml docs/**/*.rst
config.yaml:
language: en
sphinx: true
extensions:
- sphinx_panels
default_domain: py
consecutive_numbering: true
colon_fences: true
dollar_math: true
conversions:
sphinx_panels.dropdpwn.DropdownDirective: parse_all
有关更多信息，请参阅文档：https://rst-to-myst.readthedocs.io/
开发
此软件包使用flit作为构建引擎，并使用tox进行测试自动化。
要安装这些开发依赖项
pip install flit tox
运行测试
tox
运行代码格式化和样式检查
pip install pre-commit
pre-commit run --all
发布到PyPi
直接使用flit
flit publish
或通过创建一个与版本相等的标签来触发GitHub Action作业，例如v0.0.1。
请注意，这需要在 PyPi 上生成一个 API 密钥，并将其添加到仓库 Settings/Secrets 下的 PYPI_KEY 名称。
待办事项
转换涵盖了几乎所有语法（见 https://docutils.sourceforge.io/docs/user/rst/quickref.htm），除了
- 行块
- 选项列表
此外，还希望有用于指令解析的自定义函数。
下载文件
下载适用于您平台的文件。如果您不确定选择哪个，请了解有关 安装软件包 的更多信息。
源分发
rst_to_myst-0.4.0.tar.gz (37.8 kB 查看哈希值)
构建分发
rst_to_myst-0.4.0-py3-none-any.whl (36.5 kB 查看哈希值)