fabpot/sphinx-php

Sphinx extension for PHP projects

Fund package maintenance!
fabpot

Installs: 30 613

Dependents: 1

Suggesters: 0

Security: 0

Stars: 162

Watchers: 11

Forks: 36

Open Issues: 6

Language:Python

v2.0.1 2020-07-10 07:02 UTC

README

Installation

You can install the extension by:

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

  • cloning the project and add sensio to your path (with something like sys.path.insert(0, os.path.abspath('./path/to/sensio'))).

  • Arch Linux users can use the AUR package

Requirements

Sphinx 1.8.5 (not older, not newer) is required.

Usage

You can use the following extensions in your conf.py file:

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

To enable highlighting for PHP code not between <?php ... ?> by default:

# 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)

And here is how to use PHP as the primary domain:

primary_domain = 'php'

Configure the api_url for links to the API:

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