wordpress/phpdoc-parser

Static code parser for WordPress source.

Installs: 318

Dependents: 2

Suggesters: 0

Security: 0

Stars: 181

Watchers: 29

Forks: 62

Open Issues: 50

Type:wordpress-plugin

dev-master 2018-10-08 21:45 UTC

This package is not auto-updated.

Last update: 2020-06-30 22:36:46 UTC


README

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 https://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>