欧宝体育电话文档格式
编辑本页警告:您正在浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 2.0,现已不再维护。
读本页的更新版本用于Sy欧宝娱乐app下载地址mfony 6.2(当前稳定版本)。
欧宝体育电话文档格式
Symf欧宝娱乐app下载地址ony2文档使用欧宝体育电话reStructuredText作为其标记语言和斯芬克斯用于构建输出(HTML, PDF,…)。
reStructuredText
reStructuredText“是一个易于阅读、所见即所得的纯文本标记语法和解析器系统”。
您可以通过阅读现有的Symfony2了解更多关于它的语法欧宝娱乐app下载地址文档或者通过阅读reStructuredText底漆在狮身人面像网站上。
如果你熟悉Markdown,请小心,因为有时情况非常相似但又不同:
- Lists从一行的开头开始(不允许缩进);
- 内联代码块使用双引号(
这样的' ' ' '
).
斯芬克斯
Sphinx是一个构建系统,它添加了一些很好的工具来从reStructuredText文档创建文档。欧宝体育电话因此,它向标准reST添加了新的指令和解释文本角色标记.
语法高亮显示
所有代码示例都使用PHP作为默认的高亮显示语言。你可以用代码块
指令:
1 2 3
. .代码块:yaml{foo: bar, bar: {foo: bar, bar: baz}}
如果PHP代码以<?php
,那么你需要使用html + php
如突出显示的伪语言:
1 2 3
. .代码块::html + php<?PHP返回$this->foobar();? >
请注意
支持的语言列表可在Pygments网站.
配置块
方法显示配置时,必须使用配置块
指令以所有支持的配置格式显示配置(PHP
,YAML
,XML
)
12 3 4 5 6 7 8 9 10 11 12 13
. .配置块::. .代码块:yaml# YAML中的配置. .xml代码:<!——XML中的配置//——> .使用实例. .php代码:// PHP中的配置
前面的reST代码片段如下所示:
- YAML
- XML
- PHP
1
# YAML中的配置
1
<!——XML中的配置//——> .使用实例
1
// PHP中的配置
当前支持的格式列表如下:
标记格式 | 显示 |
---|---|
超文本标记语言 | 超文本标记语言 |
xml | XML |
php | PHP |
yaml | YAML |
金贾的 | 嫩枝 |
html +金贾的 | 嫩枝 |
html + php | PHP |
ini | INI |
php-annotations | 注释 |
添加链接
要在文档中添加到其他页面的链接,请使用以下语法:
1
医生:“/道路/ /页面”
使用不带扩展名的页面路径和文件名,例如:
1 2 3 4 5
医生:“/ book /控制器”医生:/组件/ event_dispatch /介绍的医生:“/食谱/配置/环境”
链接文本将是所链接文档的主标题。你也可以为链接指定替代文本:
1
医生:“假脱机邮件< /食谱/电子邮件/ spool > '
你也可以添加API文档的链接:欧宝体育电话
1 2 3 4 5
名称空间:“欧宝娱乐app下载地址Symfony \ \ \ \ BrowserKit组件”类:“欧宝娱乐app下载地址Symfony组件\ \ \ \ \ \匹配器\ \ ApacheUrlMatcher路由的方法:的欧宝娱乐app下载地址Symfony \ \ HttpKernel \ \ \ \组件包\ \包::构建的
和PHP文档:欧宝体育电话
1 2 3 4 5
: phpclass:“SimpleXMLElement”: phpmethod:DateTime:: createFromFormat”: phpfunction:“iterator_to_array”
安装Sphinx扩展
- 从源存储库
- 复制
sensio赞助
目录到_exts
文件夹下的源文件夹(其中conf.py
位于) - 将以下内容添加到
conf.py
文件:
12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20
#……sys.path.append (os.path.abspath (“_exts”))#添加PhpLexer从sphinx.highlighting进口词法分析器从pygments.lexers.web进口PhpLexer#……#添加扩展到扩展列表扩展名=[…]“sensio.sphinx.refinclude”,“sensio.sphinx.configurationblock”,“sensio.sphinx.phpcode”]#为PHP代码启用高亮显示,而不是在' ' ' '默认词法分析器(“php”] = PhpLexer(startinline=真正的)词法分析器“php-annotations”] = PhpLexer(startinline=真正的)#使用PHP作为主要域primary_domain =“php”#设置API链接的urlapi_url =“http://api.欧宝娱乐app下载地址www.oldmanjams.com/master/%s”
此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。