mirror of
https://github.com/PHPOffice/PhpSpreadsheet.git
synced 2026-08-18 04:23:48 +00:00
oleibman
bc6c09c8da
Documenting public and protected methods is useful; I don't believe it is useful to document private methods. If people really need them, they can clone the project and run PhpDocumentor against it. As long as I'm at it, we are several releases behind in PhpDocumentor. Use the latest (3.8.1 replacing 3.5.0). I have confirmed that this works locally on my machine. There's no real way to verify the change until the next PhpSpreadsheet release. Hope it works.
34 lines
902 B
YAML
34 lines
902 B
YAML
name: GithHub Pages
|
|
on:
|
|
push:
|
|
tags:
|
|
- '*'
|
|
|
|
permissions: {}
|
|
jobs:
|
|
github-pages:
|
|
permissions:
|
|
contents: write # to push pages branch (peaceiris/actions-gh-pages)
|
|
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Setup PHP, with composer and extensions
|
|
uses: shivammathur/setup-php@v2
|
|
with:
|
|
php-version: 8.3
|
|
coverage: none # remove xdebug
|
|
|
|
- name: Build API documentation
|
|
run: |
|
|
curl -LO https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.8.1/phpDocumentor.phar
|
|
php phpDocumentor.phar --directory src/ --target docs/api --visibility=public,protected
|
|
|
|
- name: Deploy to GithHub Pages
|
|
uses: peaceiris/actions-gh-pages@v3
|
|
with:
|
|
github_token: ${{ secrets.GITHUB_TOKEN }}
|
|
publish_dir: ./docs/api
|