Sphinx PHP Doc RST : Generate Sphinx documentation from PHPDoc comments

Recommend this page to a friend!

Download .zip

Info

Documentation

View files (161)

Download .zip

Reputation

Support forum

Blog

Links

Last Updated		Ratings				Unique User Downloads		Download Rankings
2019-08-31 (2 hours ago)		Not yet rated by the users				Total: Not yet counted		Not yet ranked

Version		License		PHP version		Categories
`phpdoc-to-rst` 1.0		MIT/X Consortium ...		7		PHP 5, Utilities and Tools, Parsers

Collaborate with this project Author

phpdoc-to-rst - github.com

Description

This package can generate Sphinx documentation from PHPDoc comments.

It can traverse the PHP source code files and parses them to extract documentation of class functions and variables.

The package can generate output in Sphinx ReStructured Text format.

Innovation Award

August 2019
Nominee
Vote

Sphinx is the name of a format and a tool to generate documentation for the Python language.

Like the Python language, it uses indentation to show the different levels of nested content in a way that makes it more readable what is the level of nesting of document blocks that are contained in the respective parent document blocks.

This package can generate documentation in Sphinx format from PHP classes that contain function and variable documentation details in comments formatted in the PHPDoc format.

Manuel Lemos

Francesco Danti

Performance

Level

Level 1

Innovation award

Nominee: 2x

Files

File	Role	Description
`bin` (1 file)
`docs` (8 files, 4 directories)
`example` (1 file)
`src` (3 files, 3 directories)
`.readthedocs.yml`	Data	Auxiliary data
`.travis.yml`	Data	Auxiliary data
`composer.json`	Data	Auxiliary data
`LICENSE`	Lic.	License text
`Makefile`	Data	Auxiliary data
`phpunit.xml`	Data	Auxiliary data
`README.md`	Doc.	Documentation
`renovate.json`	Data	Auxiliary data

File	Role	Description
`phpdoc-to-rst`	Example	Example script

File	Role	Description
`api` (2 files, 1 directory)
`_build` (1 directory)
`_static` (1 file)
`_templates` (1 file)
`cli.rst`	Data	Auxiliary data
`conf.py`	Data	Auxiliary data
`extensions.rst`	Data	Auxiliary data
`index.rst`	Data	Auxiliary data
`make.bat`	Data	Auxiliary data
`Makefile`	Data	Auxiliary data
`requirements.txt`	Doc.	Documentation
`usage.rst`	Data	Auxiliary data

File	Role	Description
`JuliusHaertl` (1 directory)
`index-namespaces-all.rst`	Data	Auxiliary data
`index.rst`	Data	Auxiliary data

File	Role	Description
`PHPDocToRst` (4 files, 3 directories)

File	Role	Description
`Builder` (10 files)
`Extension` (9 files)
`Middleware` (2 files)
`ApiDocBuilder.rst`	Data	Auxiliary data
`GenerateDocumentationCommand.rst`	Data	Auxiliary data
`index.rst`	Data	Auxiliary data
`WriteException.rst`	Data	Auxiliary data

File	Role	Description
`ClassFileBuilder.rst`	Data	Auxiliary data
`ExtensionBuilder.rst`	Data	Auxiliary data
`FileBuilder.rst`	Data	Auxiliary data
`index.rst`	Data	Auxiliary data
`InterfaceFileBuilder.rst`	Data	Auxiliary data
`MainIndexBuilder.rst`	Data	Auxiliary data
`NamespaceIndexBuilder.rst`	Data	Auxiliary data
`PhpDomainBuilder.rst`	Data	Auxiliary data
`RstBuilder.rst`	Data	Auxiliary data
`TraitFileBuilder.rst`	Data	Auxiliary data

File	Role	Description
`AddFullElementNameExtension.rst`	Data	Auxiliary data
`Extension.rst`	Data	Auxiliary data
`GithubLocationExtension.rst`	Data	Auxiliary data
`HideChildNamespaces.rst`	Data	Auxiliary data
`index.rst`	Data	Auxiliary data
`InterfaceImplementors.rst`	Data	Auxiliary data
`NoPrivateExtension.rst`	Data	Auxiliary data
`PublicOnlyExtension.rst`	Data	Auxiliary data
`TocExtension.rst`	Data	Auxiliary data

File	Role	Description
`ErrorHandlingMiddleware.rst`	Data	Auxiliary data
`index.rst`	Data	Auxiliary data

File	Role	Description
`html` (9 files, 3 directories)

File	Role	Description
`api` (2 files, 1 directory)
`_sources` (4 files, 1 directory)
`_static` (21 files, 3 directories)
`.buildinfo`	Data	Auxiliary data
`cli.html`	Doc.	Documentation
`extensions.html`	Doc.	Documentation
`genindex.html`	Doc.	Documentation
`index.html`	Doc.	Documentation
`php-modindex.html`	Doc.	Documentation
`search.html`	Doc.	Documentation
`searchindex.js`	Data	Auxiliary data
`usage.html`	Doc.	Documentation

File	Role	Description
`JuliusHaertl` (1 directory)
`index-namespaces-all.html`	Doc.	Documentation
`index.html`	Doc.	Documentation

File	Role	Description
`PHPDocToRst` (4 files, 3 directories)

File	Role	Description
`Builder` (10 files)
`Extension` (9 files)
`Middleware` (2 files)
`ApiDocBuilder.html`	Doc.	Documentation
`GenerateDocumentationCommand.html`	Doc.	Documentation
`index.html`	Doc.	Documentation
`WriteException.html`	Doc.	Documentation

File	Role	Description
`ClassFileBuilder.html`	Doc.	Documentation
`ExtensionBuilder.html`	Doc.	Documentation
`FileBuilder.html`	Doc.	Documentation
`index.html`	Doc.	Documentation
`InterfaceFileBuilder.html`	Doc.	Documentation
`MainIndexBuilder.html`	Doc.	Documentation
`NamespaceIndexBuilder.html`	Doc.	Documentation
`PhpDomainBuilder.html`	Doc.	Documentation
`RstBuilder.html`	Doc.	Documentation
`TraitFileBuilder.html`	Doc.	Documentation

File	Role	Description
`AddFullElementNameExtension.html`	Doc.	Documentation
`Extension.html`	Doc.	Documentation
`GithubLocationExtension.html`	Doc.	Documentation
`HideChildNamespaces.html`	Doc.	Documentation
`index.html`	Doc.	Documentation
`InterfaceImplementors.html`	Doc.	Documentation
`NoPrivateExtension.html`	Doc.	Documentation
`PublicOnlyExtension.html`	Doc.	Documentation
`TocExtension.html`	Doc.	Documentation

File	Role	Description
`ErrorHandlingMiddleware.html`	Doc.	Documentation
`index.html`	Doc.	Documentation

File	Role	Description
`api` (2 files, 1 directory)
`cli.rst.txt`	Doc.	Documentation
`extensions.rst.txt`	Doc.	Documentation
`index.rst.txt`	Doc.	Documentation
`usage.rst.txt`	Doc.	Documentation

File	Role	Description
`JuliusHaertl` (1 directory)
`index-namespaces-all.rst.txt`	Doc.	Documentation
`index.rst.txt`	Doc.	Documentation

	phpdoc-to-rst-2019-08-31.zip
	phpdoc-to-rst-2019-08-31.tar.gz
	Install with Composer

Version Control

Unique User Downloads

100%

Total:	0
This week:	0

Applications that use this package

No pages of applications that use this class were specified.

If you know an application of this package, send a message to the author to add a link here.

Advertise on this site

For more information send a message to info at phpclasses dot org.

File	Role	Description
`css` (2 files)
`fonts` (1 file)
`js` (2 files)
`ajax-loader.gif`	Icon	Icon image
`basic.css`	Data	Auxiliary data
`comment-bright.png`	Icon	Icon image
`comment-close.png`	Icon	Icon image
`comment.png`	Icon	Icon image
`doctools.js`	Data	Auxiliary data
`documentation_options.js`	Data	Auxiliary data
`down-pressed.png`	Icon	Icon image
`down.png`	Icon	Icon image
`file.png`	Icon	Icon image
`jquery.js`	Data	Auxiliary data
`language_data.js`	Data	Auxiliary data
`minus.png`	Icon	Icon image
`plus.png`	Icon	Icon image
`pygments.css`	Data	Auxiliary data
`searchtools.js`	Data	Auxiliary data
`style.css`	Data	Auxiliary data
`underscore.js`	Data	Auxiliary data
`up-pressed.png`	Icon	Icon image
`up.png`	Icon	Icon image
`websupport.js`	Data	Auxiliary data

File	Role	Description
`Builder` (9 files)
`Extension` (8 files)
`Middleware` (1 file)
`ApiDocBuilder.php`	Class	Class source
`GenerateDocumentationCommand.php`	Class	Class source
`WriteException.php`	Class	Class source

File	Role	Description
`ClassFileBuilder.php`	Class	Class source
`ExtensionBuilder.php`	Class	Class source
`FileBuilder.php`	Class	Class source
`InterfaceFileBuilder.php`	Class	Class source
`MainIndexBuilder.php`	Class	Class source
`NamespaceIndexBuilder.php`	Class	Class source
`PhpDomainBuilder.php`	Class	Class source
`RstBuilder.php`	Class	Class source
`TraitFileBuilder.php`	Class	Class source

File	Role	Description
`AddFullElementNameExtension.php`	Class	Class source
`Extension.php`	Class	Class source
`GithubLocationExtension.php`	Class	Class source
`HideChildNamespaces.php`	Class	Class source
`InterfaceImplementors.php`	Class	Class source
`NoPrivateExtension.php`	Class	Class source
`PublicOnlyExtension.php`	Class	Class source
`TocExtension.php`	Class	Class source

File	Role	Description
`ClassFileBuilder.rst.txt`	Doc.	Documentation
`ExtensionBuilder.rst.txt`	Doc.	Documentation
`FileBuilder.rst.txt`	Doc.	Documentation
`index.rst.txt`	Doc.	Documentation
`InterfaceFileBuilder.rst.txt`	Doc.	Documentation
`MainIndexBuilder.rst.txt`	Doc.	Documentation
`NamespaceIndexBuilder.rst.txt`	Doc.	Documentation
`PhpDomainBuilder.rst.txt`	Doc.	Documentation
`RstBuilder.rst.txt`	Doc.	Documentation
`TraitFileBuilder.rst.txt`	Doc.	Documentation

File	Role	Description
`AddFullElementNameExtension.rst.txt`	Doc.	Documentation
`Extension.rst.txt`	Doc.	Documentation
`GithubLocationExtension.rst.txt`	Doc.	Documentation
`HideChildNamespaces.rst.txt`	Doc.	Documentation
`index.rst.txt`	Doc.	Documentation
`InterfaceImplementors.rst.txt`	Doc.	Documentation
`NoPrivateExtension.rst.txt`	Doc.	Documentation
`PublicOnlyExtension.rst.txt`	Doc.	Documentation
`TocExtension.rst.txt`	Doc.	Documentation

File	Role	Description
`ErrorHandlingMiddleware.rst.txt`	Doc.	Documentation
`index.rst.txt`	Doc.	Documentation

File	Role	Description
`badge_only.css`	Data	Auxiliary data
`theme.css`	Data	Auxiliary data

File	Role	Description
`modernizr.min.js`	Data	Auxiliary data
`theme.js`	Data	Auxiliary data