狮身人面像主题集
sphinxtheme.plone的Python项目详细描述
sphinx.themes.plone是Plone文档项目的Sphinx主题集合。
不同的主题用于docs.plone.org,但不限于此。 它可能用于所有plone包文档,甚至是私有用例,但比没有plone徽标和页脚(尊重许可证)要好。
功能
- sphinxtheme.plone自带
- 主题
- PLONE经典(PLONE 2.0-3.3设计)
- Plone Sunburst(Plone 4设计)
- Plone Barceloneta(Plone 5设计)
- plone org 4(plone 4的生成)
- plone org 5(plone 5的生成)
安装
建筑
安装sphinxtheme.plone和buildout:
[buildout] parts= sphinx [sphinx] recipe=zc.recipe.egg eggs= Sphinx sphinxtheme.plone
pip安装
用pip安装sphinxtheme.plone:
pip install Sphinx sphinxtheme.plone
或者将其添加到requirements.txt并运行
pip install -r requirements.txt
小心!
您不应该使用主题包的签出来将主题应用于文档。 不要触摸这个包来调整配置或定制部件,这是没有必要的。 请阅读文档:http://docs.plone.org/…
配置
编辑“conf.py”配置文件以指向plone主题:
# At the top. import sphinxtheme.plone # ... # Activate the theme path: html_theme_path = sphinxtheme.plone.get_html_theme_path() # Activate the theme like this: html_theme = 'plone_org_4'
主题的其他开关,请参阅详细文档。 对于当前的docs.plone.org,始终设置以下内容(这应该在相关纸草分支的conf.py中完成):
始终显示版本切换器=真 始终显示语言切换器=真 selected_version=下拉列表中应该预选的文档版本,因此5、4或3
可用主题
- 经典音乐
- 组织4
- plone_org_5(待办事项:待最后确定)
- Plone_Sunburst(待办事项:待定)
- plone_barceloneta(待办事项:待实施)
贡献
许可证
- 本项目的技术部分是根据GPLV2许可证授权的。
- 此包/生成页面中的文本和插图由Plone基金会根据Creative Commons Attribution 4.0国际许可授权。
- PLONE和PLONE商标是PLONE基金会在美国和其他国家注册的注册商标。
- 关于许可使用Plone商标的指南,请参见https://plone.org/foundation/logo
- 所有其他商标归其各自所有者所有。