mattacosta/phd-common

Base types for generating PHP documentation.

Maintainers

Details

github.com/mattacosta/phd-common

Source

Issues

Installs: 6

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

dev-master 2021-01-13 06:59 UTC

Requires

  • php/phd: @dev

MIT 68ff6d541a825dae8079a5bfbad49285e51cc650

This package is auto-updated.

Last update: 2024-04-13 14:39:59 UTC

README

Base types for generating PHP documentation.

Requirements

Installation

  1. Add mattacosta/phd-common to your composer.json file.

Getting started

  1. Get a copy of the PHP manual.

    git clone https://github.com/php/doc-base.git phpdoc/doc-base

    git clone https://github.com/php/doc-en.git phpdoc/en

  2. Generate a .manual.xml file.

    php phpdoc/doc-base/configure.php

  3. Create a class that extends Package_IDE_Base and implements a rendering function.

  4. Create a script to setup and run the renderer (PEAR usage is unsupported).

    You can copy the scripts/export.php file as a basic starting point.

    Usage: php scripts/export.php phpdoc/doc-base/.manual.xml