Skip to content
This repository has been archived by the owner on Mar 23, 2024. It is now read-only.

Commit

Permalink
:octocat: add readthedocs to CI
Browse files Browse the repository at this point in the history
  • Loading branch information
codemasher committed Mar 3, 2024
1 parent 33a7281 commit 7ff1edd
Showing 1 changed file with 62 additions and 28 deletions.
90 changes: 62 additions & 28 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,34 +48,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@v4

- name: "Install PHP"
uses: shivammathur/setup-php@v2
with:
php-version: "8.1"
coverage: none
tools: phpDocumentor
extensions: curl, fileinfo, intl, json, mbstring, simplexml, sodium, zlib

- 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: docs
CLEAN: true


tests:
name: "Unit Tests"
needs: static-code-analysis
Expand Down Expand Up @@ -120,3 +92,65 @@ 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@v4

- name: "Install PHP"
uses: shivammathur/setup-php@v2
with:
php-version: "8.1"
coverage: none
tools: phpDocumentor
extensions: curl, fileinfo, intl, json, mbstring, simplexml, sodium, zlib

- 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@v4

- name: "Install PHP"
uses: shivammathur/setup-php@v2
with:
php-version: "8.1"
coverage: none

- name: "Install Sphinx"
run: pip install sphinx myst-parser sphinx-rtd-theme

- name: "Install dependencies with composer"
uses: ramsey/composer-install@v2

- name: "Build manual"
run: |
cd docs
make html
- name: "Publish user manual to branch readthedocs"
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: readthedocs
folder: .build/sphinx/html
clean: true

0 comments on commit 7ff1edd

Please sign in to comment.