Documentation parser powering developer.wordpress.org
Switch branches/tags
Nothing to show
Clone or download
atimmer Merge pull request #187 from ntwb/patch-1
Add PHP 7.1 to Travis CI job matrix
Latest commit 1bd9179 Jan 13, 2018

README.md

WP Parser

WP-Parser is the parser for creating the new code reference at developer.wordpress.org. It parses the inline documentation and produces custom post type entries in WordPress.

We are currently looking for contributors to help us complete the work on the parser.

There is a guide to developing for developer.wordpress.org in the WordPress documentation handbook

Requirements

Clone the repository into your WordPress plugins directory:

git clone git@github.com:WordPress/phpdoc-parser.git 

After that install the dependencies using composer in the parser directory:

composer install

Running

Activate the plugin first:

wp plugin activate phpdoc-parser

In your site's directory:

wp parser create /path/to/source/code --user=<id|login>