目前,我能找到获取readthedocs.org使用的当前设计资产的唯一方法是安装full theme并构建它,这需要SASS等。
我想获得一组静态文件,让我在本地看到我的构建在readthedocs上的样子。有没有办法在没有从上面的链接建立资产的情况下做到这一点?目标是让新手轻松 以便为文档做出贡献。
答案 0 :(得分:1)
如果您想为其贡献/开发,您只需要构建主题。您可以使用pip install sphinx_rtd_theme
安装主题。然后,您可以在Sphinx conf.py
中使用主题。请参阅:http://read-the-docs.readthedocs.org/en/latest/theme.html
# on_rtd is whether we are on readthedocs.org
import os
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if not on_rtd: # only import and set the theme if we're building docs locally
import sphinx_rtd_theme
html_theme = 'sphinx_rtd_theme'
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
# otherwise, readthedocs.org uses their theme by default, so no need to specify it