sphinx的docs.typo3.org主题,从2015年开始。

t3SphinxThemeRtd的Python项目详细描述



==
一个新的主题为docs.typo3.org网站的新主题
=====================================================

:项目:t3sphinxthemertd
:团队:typo3文档团队
:作者:martin:martin bless<;martin.bless@typo3.org>;
:许可证:mit
:演示:见:见:见:见:见:martin bless<;martin.bless@马丁.bless@typo3.org>;
:此演示文档`T3Sphinxthemertdedemodocs
<;https://docs.typo3.org/typo3cms/drafts/github/typo3 documentation/t3sphinxthemertdedemodocs/>;` `
这是一种"压力测试",演示什么是可能的,以及如何使用主题。

在"https://github.com/snide/sphinx廑rtd廑主题
<;https://github.com/snide/sphinx廑rtd廑主题

…默认角色::代码

…内容:
:本地:
:深度:3
:反向链接:top




installation
=




`pypi<;https://pypi.python.org/pypi>;` ` ` `.
't3sphinxthemertd'的ager由typo3文档团队提供,可从pypi获得。


/>
如果您的系统需要,请运行一个超级用户:
pip install--升级t3sphinxthemertd

安装--升级--用户t3sphinxthemertd

etup.py'
---------------------------


从包中直接安装::

cd t3sphinxthemertd
(sudo)python setup.py install

ython setup.py——用户安装



usage
=



在文档项目的"conf.py"文件中:


>加载模块::


import t3sphinxthemertd

选择主题::

html-theme="t3sphinxthemertd"

设置主题路径::


html_-theme_path=[t3sphinxthemertd.get_-html_-theme_-path()]


,或者,如果您的情况更好,请将主题路径添加到已定义路径的
列表中::

……
html_-theme_-path.append(t3sphinxthemertd.get_-html_-theme_-path())



类型3用户的特殊信息禁用或删除任何现有的"typo3 codeblock"

如果"typo3 codeblock"是"conf.py"文件的一部分,则需要删除或禁用该代码。
您可以通过编写"if 0"而不是"if 1"轻松完成此操作。

图::documentation/images/disable-typo3-codeblock.png
:alt:如何在conf.py中禁用现有的typo3代码块

禁用"typo3代码块"后,将不再使用旧的"t3sphinx模块
<;https://git.typo3.org/documentation/resttools.git/tree/head:/extendingsphinxfortypo3/src/t3sphinx>;`\uu
。所以你终于从旧的压舱物中解脱出来了,一些旧的、烦人的错误也消失了。呈现sphinx json
格式只会在新的主题。另一方面:由于"t3sphinx模块"不再加载
目前没有处理yaml文件进行配置。这意味着,至少现在是这样:

-您必须使用"conf.py"文件进行配置。
-您需要将所有必要的设置从可能的"globalsettings.yml"和"settings.yml"文件移到"conf.py"文件中。

4。也许我们以后会增加山药加工。目前这不存在。

5.**快速开始:**请随意从这个
`typoscript reference conf.py示例文件中复制
<;文档/示例/typoscript reference example-conf.py>;``相关部分在末尾。





网站
<;http://mbless.de/blog/2015/06/2015/06/16/a-new-theme-for-docs-typo3-org.html 待完成>;` <




<
>Changelog
====







<3.1.0
>-使用小型jquery
-添加我们的"编辑我在github上的我"按钮



.0.0
----

-首先公共版本。
我们开始用版本号3.0.0对这个rtd主题的typo3分支进行编号
这显然不同于最初的"sphinx_rtd_theme"版本号v0.1.8。


已经完成了2015/06/06/16/16/A-New-theme-for-docs-typo3-org.html"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的"内容表如何构建了"的"已经完成了"的"已经完成了"的"已经完成了"的"已经完成了"的










>
贡献或修改th峨眉
==


>本章摘自《自述》原文(http://github.com/snide/snide/sphinx-sphinx-rtd-theme>;```(然后修改)::


这一``t3sphinxthemertd``主要是一个` sass<;http://sass-lang.com/>;`http://sass-lang.com/>;`http://sass-lang.com/>;``t3sphinxthemertd``主要是一个` sass<;http://sass-s-lang.com/>;`http://sass-lang.com/>;````
需要一些其他SASS库。我们使用"bower<;http://bower.io/>;``来
管理这些依赖项和sass来构建css。好消息是,
有一组很好的"grunt<;http://gruntjs.com/>;``操作,这些操作不仅可以加载
这些依赖项,还可以监视更改、重新生成sphinx演示文档并构建
主题的可分发版本。坏消息是,这意味着您需要设置类似于前端开发人员的环境(而不是python开发人员的环境)。这意味着安装"node<;https://nodejs.org/>;`
和"ruby<;https://www.ruby-lang.org/>;`


建立一个开发环境。安装"sphinx<;http://sphinx doc.org/>;`然后:

pip安装sphinx

2。安装sass::


>3。安装node、bower和grunt::

NPM安装



>5。您可能需要将"livereload addons"添加到您的
Firefox和Chrome浏览器中。现在我们的环境已经设置好,请确保您在虚拟环境中,转到终端中的包并运行grunt::


cd t3sphinxthemertd

,或者,甚至可以更好地在后台运行grunt::

cd t3sphinxthemertd
grunt&;br/>e**.

1.它将安装并更新任何Bower依赖项。
2.它将运行sphinx并构建演示文档。
3.它将监视sass文件的更改,并根据更改构建css。
4.只要注意到.rst、.html、.js
或.css文件的更改,它就会重新生成sphinx演示文档。它将在localhost:1919启动一个本地web服务器。它将在浏览器中显示演示文档。
7.如果启用了livereload,它将自动刷新localhost:1919的浏览器。

例如,字体被移到
正确的位置。

**注意:**我需要手动运行"grunt copy"的复制操作。
默认情况下不会运行。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java如何根据特定条件替换方括号内的单词   java为什么从数组流式传输时不能将整数映射到字符串?   java如何更改首选项活动主题?   java在JComboBox中显示时区   java我可以通过文档对象将PDF上传到SugarCRM吗?   web服务如何调用。通过NTLM身份验证从java客户端提供基于Net的Web服务   java使用Servlet读取Jar内部的清单文件   java当我们声明变量时,编译器实际上做什么?   寻找印地语背后的java直觉   java如何设置表格布局的样式   java Android在目标类上指定默认值   if语句在这两个java行中jvm是否存在任何差异:   java网格正在脱离屏幕   java将XLSX行转换为字符串并添加到数组   java JSF2 ResourceBundleLoader覆盖?