Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/workflows/docs-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Generate MkDocs

on:
pull_request:
branches: ["dev"]

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Check out the repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: "3.10"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install mkdocs
pip3 install $(mkdocs get-deps)
sudo apt-get update
sudo apt-get install php
sudo apt-get install -y lftp
sudo apt-get install nodejs
sudo apt-get install npm
sudo npm i openapi-to-md -g
- name: Start Hashtopolis server
uses: ./.github/actions/start-hashtopolis
- name: Download newest apiv2 spec
run: |
wget http://localhost:8080/api/v2/openapi.json -P /tmp/
cat /tmp/openapi.json
openapi-to-md /tmp/openapi.json ./doc/api/
- name: Create function level documentation with phpdocumentor
run: |
wget https://phpdoc.org/phpDocumentor.phar -P /tmp/
sudo php /tmp/phpDocumentor.phar --ignore vendor/ -d . -t ./doc/php-documentor/
- name: Build MkDocs site
run: |
mkdocs build