Github 如何在Sphinx';s conf.py
我正在使用Sphinx来记录一个项目,以便在阅读文档时发布 一些内容需要链接到GitHub repo中的一些文件,以便链接到的文件版本与所记录的代码版本匹配 例如,如果文档的版本为Github 如何在Sphinx';s conf.py,github,python-sphinx,read-the-docs,Github,Python Sphinx,Read The Docs,我正在使用Sphinx来记录一个项目,以便在阅读文档时发布 一些内容需要链接到GitHub repo中的一些文件,以便链接到的文件版本与所记录的代码版本匹配 例如,如果文档的版本为2f5dabe0,则我可能希望链接到: https://github.com/approvals/ApprovalTests.cpp/blob/2f5dabe0/tests/UT_Tests/UTApprovalTestTests.cpp#L58-L73 或者使用完整的提交ID: https://github.com/
2f5dabe0
,则我可能希望链接到:
https://github.com/approvals/ApprovalTests.cpp/blob/2f5dabe0/tests/UT_Tests/UTApprovalTestTests.cpp#L58-L73
或者使用完整的提交ID:
https://github.com/approvals/ApprovalTests.cpp/blob/2f5dabe0a533deeedc025d595d5534967737fed5/tests/UT_Tests/UTApprovalTestTests.cpp#L58-L73
在不添加任何依赖项(如GitPython)的情况下,如何在Sphinx的conf.py中获取Git提交ID?使用idea from,并对该特定请求进行一些修改,以下内容将以字符串形式生成完整的提交ID:
import subprocess
commit_id = subprocess.check_output(['git', 'rev-parse', 'HEAD']).strip().decode('ascii')
如果希望获得缩短的提交id,可以执行以下操作:
commit_id = subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD']).strip().decode('ascii')
使用中的idea,并对该特定请求进行一些修改,以下内容将以字符串形式生成完整的提交ID:
import subprocess
commit_id = subprocess.check_output(['git', 'rev-parse', 'HEAD']).strip().decode('ascii')
如果希望获得缩短的提交id,可以执行以下操作:
commit_id = subprocess.check_output(['git', 'rev-parse', '--short', 'HEAD']).strip().decode('ascii')