Sphinx Extensions for PHP和Symfony技术文档

1. 安装指南

安装此扩展有几种方式：

• 使用pip安装，运行以下命令：

  sudo pip install git+https://github.com/fabpot/sphinx-php.git
  

• 克隆项目并将sensio添加到您的路径中（例如使用以下命令）：

  sys.path.insert(0, os.path.abspath('./path/to/sensio'))
  

• 对于Arch Linux用户，可以使用AUR包

注意：需要确保安装的Sphinx版本为1.8.5。

2. 项目的使用说明

在您的conf.py文件中，可以使用以下扩展：

• sensio.sphinx.configurationblock
• sensio.sphinx.phpcode
• sensio.sphinx.bestpractice

若要默认为不在<?php ... ?>标签内的PHP代码启用高亮显示，请执行以下操作：

# 加载PhpLexer
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

# 默认为不在 ``<?php ... ?>`` 标签内的PHP代码启用高亮显示
lexers['php'] = PhpLexer(startinline=True)
lexers['php-annotations'] = PhpLexer(startinline=True)

若要将PHP作为主域，请设置：

primary_domain = 'php'

配置api_url以链接到API：

api_url = 'http://api.symfony.com/master/%s'

3. 项目API使用文档

本项目API使用文档暂无详细说明，建议关注项目官方文档和仓库以获取最新信息。

4. 项目安装方式

项目的安装方式已在“安装指南”一节中说明，以下为简要概括：

• 使用pip进行安装。
• 手动克隆项目并配置项目路径。
• Arch Linux用户可通过AUR包安装。