sphinx的github指令和角色
项目描述
在您的sphinx简历/项目中展示github存储库和pull请求。
安装
$ pip install sphinxcontrib-github将sphinxcontrib-github添加到您的conf.py中的extensions。
extensions.append('sphinxcontrib.github')或者更改
extensions = ['sphinx.ext.intersphinx', ...]为
extensions = ['sphinx.ext.intersphinx', 'sphinxcontrib.github', ...]设置API访问
第一次使用需要输入您的github用户名和密码。阅读登录源。它将在github创建一个API密钥，并在项目目录中保存api id和api密钥以供将来使用。
将.github.auth添加到您的.gitignore。
使用
github pull request角色
:github-pr:`saltstack/salt/pull/7665`输出
24次添加(+), 12次删除(-) 2013-10-08
github repo角色
:github-repo:`saltstack/salt`输出
salt-states-configs: github
github repo指令
.. github-repo:: saltstack/salt
:homepage: http://www.saltstack.org/
:travis: https://www.travis-ci.org/saltstack/salt/
:docs: http://salt.readthedocs.org/en/v0.16.4/
:api: http://salt.readthedocs.org/en/v0.16.4/ref/python-api.html
:pypi: https://pypi.python.org/pypi/salt输出
github - travis - docs - api - pypi - homepage - 2296 watchers - 813 forks
python支持 |
2.7 |
sphinx支持 |
>=0.6 |
文档 |
|
API |
http://sphinxcontrib-github.readthedocs.org/en/latest/api.html |
更新日志 |
http://sphinxcontrib-github.readthedocs.org/en/latest/history.html |
问题 |
|
源代码 |
|
pypi |
|
许可证 |
关闭
sphinxcontrib-github-0.1.3.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | ae8cc9d0a9fb99b90a236ea71f306644032e856956054f171a890c32f8d82d6d |
|
| MD5 | 931cef00b0e8146718a1ac816eb48972 |
|
| BLAKE2b-256 | b203fdf5b89ecddab89b9a11d52e08b2398d8f8558bb8389707ab40ee6ab9368 |
