下一步为狮身人面像训练主题并阅读文档
nextstrain-sphinx-theme的Python项目详细描述
一个Sphinx theme,用于Nextstrain的文档,基于Read The Docs' 默认主题(sphinx_rtd_theme)。在
安装
这个主题在PyPI上以nextstrain-sphinx-theme的形式发布,可以 与pip一起安装:
$ python3 -m pip install nextstrain-sphinx-theme
要在Sphinx项目中使用主题,需要将以下内容添加到 您的conf.py文件:
^{pr2}$这个主题基于sphinx_rtd_theme并接受所有相同的内容 configuration options可通过html_theme_option设置。另外一个 支持选项:
logo: | Boolean determining if the Nextstrain logo should be displayed. Defaults to true. |
---|
如果您的项目想要显示自己的logo,只需设置Sphinx的html_logo 指向Sphinx项目中的图像文件。在
html_logo="_static/your-logo.png"
这将自动优先于默认的Nextstrain徽标 由主题提供。在
释放
- 请确保您有一个PyPI帐户并有权访问https://pypi.org/project/nextstrain-sphinx-theme/。在
- 确保所有更改都已提交给main分支。在
- {{tt7$更新了前一个版本^和tt7}中的更改。在
- 用版本号标记这个提交,例如git tag -a 2020.4 -m "version 2020.4"。在
- 将commit和标记推送到main分支。在
- Generate the source and binary distributions with setup.py。在
- Upload the two files from step 3 to PyPI with twine。在
- 项目
标签: