fabpot/sphinx-php

此包已被放弃，不再维护。未建议替代包。

PHP项目的Sphinx扩展

维护者

详细信息

github.com/fabpot/sphinx-php

源代码

问题

资助包维护！
fabpot

安装量: 80,073

依赖项: 0

建议者: 0

安全: 0

星标: 165

关注者: 11

分支: 38

开放问题: 0

语言:Python

v2.0.2 2020-09-12 08:29 UTC

MIT 0dd00a11f2529b483614286e2bca929cfccfdabf

  • Fabien Potencier <fabien.woop@symfony.com>

This package is auto-updated.

Last update: 2022-05-12 11:54:46 UTC

README

安装

您可以通过以下方式安装扩展

  • 运行 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（不是更老，也不是更新）。

使用

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

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

默认情况下启用 <?php ... ?> 之外的PHP代码的突出显示

# loading PhpLexer
from sphinx.highlighting import lexers
from pygments.lexers.web import PhpLexer

# enable highlighting for PHP code not between ``<?php ... ?>`` by default
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'