Generate PHP docs with clean/phpdoc-md
ActionsTags
(2)
GitHub action to generate PHP project documentation in MarkDown format. Based on clean/phpdoc-md library.
To use this action in your project, create workflow in your project similar to this code (Note: some parts and arguments needs to be altered):
name: Generate documentation
on:
push:
jobs:
get_php_classes_list:
runs-on: ubuntu-latest
steps:
- name: Checkouting project code...
uses: actions/checkout@v2
- name: Install PHP
uses: shivammathur/setup-php@v2.2
with:
php-version: 8.1
extensions: curl, gd, pdo_mysql, json, mbstring, pcre, session
ini-values: post_max_size=256M
coverage: none
tools: composer:v2
- name: Install Composer dependencies (with dev)
run: composer install --no-progress --prefer-dist --optimize-autoloader
- name: Generating documentation...
uses: impresscms-dev/generate-phpdocs-with-clean-phpdoc-md-action@v1.0.0
with:
class_root_namespace: ImpressCMS\
included_classes: ImpressCMS\**
output_path: ./docs/
- uses: actions/upload-artifact@v3
with:
name: my-artifact
path: ./docs/This action supports such arguments (used in with keyword):
| Argument | Required | Default value | Description |
|---|---|---|---|
| output_path | Yes | Path where to write generated documentation | |
| class_root_namespace | Yes | Root class namespace | |
| included_classes | Yes | Included classes list (supports glob style wildcards syntax; each line means one rule) |
If you want to add some functionality or fix bugs, you can fork, change and create pull request. If you not sure how this works, try interactive GitHub tutorial.
If you found any bug or have some questions, use issues tab and write there your questions.
Generate PHP docs with clean/phpdoc-md is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
Tags
(2)Generate PHP docs with clean/phpdoc-md is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.