wordpress / phpdoc-parser
Static code parser for WordPress source.
Installs: 14 594
Dependents: 2
Suggesters: 0
Security: 0
Stars: 239
Watchers: 30
Forks: 78
Open Issues: 60
Type:wordpress-plugin
Requires
- php: >=5.4
- composer/installers: ~1.0
- erusev/parsedown: ~1.7
- phpdocumentor/reflection: ~3.0
- psr/log: ~1.0
- scribu/lib-posts-to-posts: dev-master@dev
- scribu/scb-framework: dev-master@dev
Requires (Dev)
- phpunit/phpunit: ^7
- spatie/phpunit-watcher: ^1.23
- yoast/phpunit-polyfills: ^1.0
This package is not auto-updated.
Last update: 2024-11-13 19:56:06 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>