# sphinx-php

**Repository Path**: gislite/sphinx-php

## Basic Information

- **Project Name**: sphinx-php
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-05-03
- **Last Updated**: 2022-05-03

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

Sphinx Extensions for PHP and Symfony
=====================================

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](https://aur.archlinux.org/packages/python-sphinx-php-git/)

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'