2017 © Pedro Peláez
 

library sphinx-php

Sphinx extension for PHP projects

image

fabpot/sphinx-php

Sphinx extension for PHP projects

  • Friday, April 20, 2018
  • by fabpot
  • Repository
  • 10 Watchers
  • 152 Stars
  • 23,548 Installations
  • Python
  • 1 Dependents
  • 0 Suggesters
  • 33 Forks
  • 6 Open issues
  • 13 Versions
  • 2 % Grown

The README.md

Sphinx Extensions for PHP and Symfony

Installation

You can install the extension by:, (*1)

  • running sudo pip install git+https://github.com/fabpot/sphinx-php.git;, (*2)

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

  • Arch Linux users can use the AUR package, (*4)

Requirements

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

Usage

You can use the following extensions in your conf.py file:, (*6)

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

To enable highlighting for PHP code not between <?php ... ?> by default:, (*7)

# 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:, (*8)

primary_domain = 'php'

Configure the api_url for links to the API:, (*9)

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

The Versions

20/04 2018

dev-master

9999999-dev

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

20/04 2018

v1.0.11

1.0.11.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

18/07 2016

v1.0.10

1.0.10.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

04/11 2015

v1.0.9

1.0.9.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

19/08 2015

v1.0.8

1.0.8.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

29/10 2014

v1.0.7

1.0.7.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

22/10 2014

v1.0.6

1.0.6.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

20/10 2014

v1.0.5

1.0.5.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

15/10 2014

v1.0.4

1.0.4.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

11/06 2014

v1.0.3

1.0.3.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

06/06 2014

v1.0.2

1.0.2.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

19/12 2013

v1.0.1

1.0.1.0

Sphinx extension for PHP projects

  Sources   Download

MIT

by Fabien Potencier

27/09 2013

v1.0

1.0.0.0

Extension of Sphinx for PHP projects

  Sources   Download

by Fabien Potencier