要与Recommonmark一起使用的Sphinx扩展修复从md到rst的链接、从rst到md的链接以及到嵌入文件和dir的链接。
sphinx-md的Python项目详细描述
狮身人面像降价扩展
这个扩展修复或改进了Sphinx处理与Markdown相关的链接的方式
当它生成HTML站点时。它假定您正在使用recommonmark
扩展。在
Contents
它的作用
- 在
标记文件：将引用转换为包含定位的标记文件。在
[configuration options](autotest.md#configuration-options)
在 - 在
reST文件：修复到标记文件的显式链接。在
^{pr2}$ 在 - 在
标记文件：修复对reST文件的引用。在
[Application examples](examples/readme.rst)
在 - 在
标记文件：修复指向GitHub repo中的文件和目录的链接。在
[Makefile](/Makefile) [deploy/kustomize](/deploy/kustomize)
链接到文件可以通过两种方式之一固定，这可以在 conf.py。在
baseBranch="devel"useGitHubURL=TruecommitSHA=getenv('GITHUB_SHA')githubBaseURL="https://github.com/intelkevinputnam/pmem-csi/"
如果
useGitHubURL设置为True，它将尝试基于 您的githubBaseURL和提交到GitHub repo的SHA 由合并时的GitHub工作流确定）。如果没有可用的SHA， {cd4}的值将使用。在如果
useGitHubURL设置为False，它将把文件复制到HTML 输出目录并提供指向该位置的链接。在注意：指向文件和目录的链接应该使用相对于 回购（请参阅上面的Makefile和deploy/kustomize）。这两种方法都有效 Sphinx构建和在GitHub存储库中查看时。在
指向目录的链接始终转换为指向GitHub存储库的链接。在
在
如何使用它
- 在
安装sphinx_md扩展：
pip3 install sphinx_md
在 - 在
将
sphinx_md添加到conf.py中的扩展：extensions=['sphinx_md',...]
在 - 在
如果要使用代码段添加整个git链接 您的
conf.py：fromosimportgetenvsphinx_md_useGitHubURL=TruebaseBranch="devel"commitSHA=getenv('GITHUB_SHA')githubBaseURL='https://github.com/'+(getenv('GITHUB_REPOSITORY')or'<your_group/your_project>')+'/'githubFileURL=githubBaseURL+"blob/"githubDirURL=githubBaseURL+"tree/"ifcommitSHA:githubFileURL=githubFileURL+commitSHA+"/"githubDirURL=githubDirURL+commitSHA+"/"else:githubFileURL=githubFileURL+baseBranch+"/"githubDirURL=githubDirURL+baseBranch+"/"sphinx_md_githubFileURL=githubFileURLsphinx_md_githubDirURL=githubDirURL
在
- 项目
标签：
欢迎加入QQ群-->： 979659372
