https://github.com/sitepoint-editors/rtdsphinx-php

ReadTheDocs-friendly Sphinx skeleton for PHP projects
https://github.com/sitepoint-editors/rtdsphinx-php

Last synced: 9 days ago
JSON representation

ReadTheDocs-friendly Sphinx skeleton for PHP projects

• Host: GitHub
• URL: https://github.com/sitepoint-editors/rtdsphinx-php
• Owner: sitepoint-editors
• Created: 2015-08-18T07:46:07.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-20T09:00:11.000Z (about 9 years ago)
• Last Synced: 2024-08-01T19:47:27.100Z (3 months ago)
• Language: JavaScript
• Homepage:
• Size: 838 KB
• Stars: 34
• Watchers: 5
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• my-awesome-list - rtdsphinx-php - friendly Sphinx skeleton for PHP projects | sitepoint-editors | 34 | (JavaScript)

README

        
# RTDSPHINX-PHP: ReadTheDocs-friendly Sphinx skeleton for multi-language PHP projects

Using Sphinx and ReadTheDocs to document PHP projects is less than straightforward. This project was made to remove most hurdles, so you can start writing your documentation in minutes, rather than waste days on setting it up.

 

## Usage:

Follow [this short tutorial](http://www.sitepoint.com/fast-multi-language-docs-with-sitepoints-rtdsphinx-php/).

For a full reference of available PHPDomain directives, see [here](https://pythonhosted.org/sphinxcontrib-phpdomain/reference.html).

 

## License

MIT

## Contributing

Pull requests and suggestions accepted. If you make some nifty themes for PHP docs, let us know and we'll feature them!