:octocat: build local RTD manual

This commit is contained in:
smiley
2023-07-11 14:26:00 +02:00
parent e66c633e23
commit 2c870d58fc
+53 -28
View File
@@ -50,34 +50,6 @@ jobs:
run: php vendor/bin/phan --target-php-version=${{ matrix.php-version }}
build-docs:
name: "Build and publish Docs"
if: github.ref_name == 'main'
runs-on: ubuntu-latest
steps:
- name: "Checkout sources"
uses: actions/checkout@v3
- name: "Install PHP"
uses: shivammathur/setup-php@v2
with:
php-version: "8.1"
coverage: none
tools: phpDocumentor
extensions: fileinfo, gd, imagick, json, mbstring
- name: "Build Docs"
run: phpdoc --config=phpdoc.xml.dist
- name: "Publish Docs to gh-pages"
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: .build/phpdocs
clean: true
tests:
name: "Unit Tests"
needs: static-code-analysis
@@ -124,3 +96,56 @@ jobs:
with:
project-token: ${{ secrets.CODACY_PROJECT_TOKEN }}
coverage-reports: .build/coverage/clover.xml
build-docs:
name: "Build and publish API docs"
if: github.ref_name == 'main'
runs-on: ubuntu-latest
steps:
- name: "Checkout sources"
uses: actions/checkout@v3
- name: "Install PHP"
uses: shivammathur/setup-php@v2
with:
php-version: "8.1"
coverage: none
tools: phpDocumentor
extensions: fileinfo, gd, imagick, json, mbstring
- name: "Build API docs"
run: phpdoc --config=phpdoc.xml.dist
- name: "Publish API docs to branch gh-pages"
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: gh-pages
folder: .build/phpdocs
clean: true
build-manual:
name: "Build and publish user manual"
if: github.ref_name == 'main'
runs-on: ubuntu-latest
steps:
- name: "Checkout sources"
uses: actions/checkout@v3
- name: "Install Sphinx"
run: pip install sphinx myst-parser sphinx-rtd-theme
- name: "Build manual"
run: |
cd docs
make
- name: "Publish user manual to branch readthedocs"
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: readthedocs
folder: .build/sphinx/html
clean: true