:octocat: move phpdoc build path

This commit is contained in:
smiley
2023-07-09 16:52:36 +02:00
parent 15dcc0195f
commit 9efff85d0c
3 changed files with 3 additions and 19 deletions
+1 -4
View File
@@ -67,9 +67,6 @@ jobs:
tools: phpDocumentor
extensions: fileinfo, gd, imagick, json, mbstring
- name: "Delete Markdown files"
run: rm ./docs/*.md
- name: "Build Docs"
run: phpdoc --config=phpdoc.xml.dist
@@ -77,7 +74,7 @@ jobs:
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: docs
folder: .build/phpdocs
clean: true
-13
View File
@@ -1,13 +0,0 @@
# Auto generated API documentation
The API documentation can be auto generated with [phpDocumentor](https://www.phpdoc.org/).
There is an [online version available](https://chillerlan.github.io/php-qrcode/) via the [gh-pages branch](https://github.com/chillerlan/php-qrcode/tree/gh-pages) that is [automatically deployed](https://github.com/chillerlan/php-qrcode/deployments) on each push to main.
Locally created docs will appear in this directory. If you'd like to create local docs, please follow these steps:
- [download phpDocumentor](https://github.com/phpDocumentor/phpDocumentor/releases) v3+ as .phar archive
- run it in the repository root directory:
- on Windows `c:\path\to\php.exe c:\path\to\phpDocumentor.phar --config=phpdoc.xml`
- on Linux just `php /path/to/phpDocumentor.phar --config=phpdoc.xml`
- open [index.html](./index.html) in a browser
- profit!
+2 -2
View File
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<parser>
<target>docs</target>
<target>.build/phpdocs</target>
<encoding>utf8</encoding>
<markers>
<item>TODO</item>
</markers>
</parser>
<transformer>
<target>docs</target>
<target>.build/phpdocs</target>
</transformer>
<files>
<directory>src</directory>