forked from lthn/blockchain
235b0cb41b
Introduces a reusable GitHub Action for building documentation and updates all platform build workflows to install documentation dependencies and run 'make docs'. This ensures documentation is built and available as part of the CI process across Linux, macOS, and Windows. Also updates the docs workflow to adjust pip dependencies.
46 lines
1.2 KiB
YAML
46 lines
1.2 KiB
YAML
name: docs
|
|
permissions:
|
|
contents: read
|
|
on:
|
|
workflow_call:
|
|
|
|
jobs:
|
|
deploy:
|
|
name: Offline Local Version
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- uses: actions/checkout@v4
|
|
with:
|
|
submodules: recursive
|
|
fetch-depth: 0
|
|
- uses: actions/setup-python@v4
|
|
with:
|
|
python-version: 3.x
|
|
|
|
- name: Install Conan
|
|
uses: conan-io/setup-conan@v1
|
|
with:
|
|
home: ${{ github.workspace }}/build/sdk
|
|
cache_packages: true
|
|
|
|
- uses: actions/cache@v4
|
|
with:
|
|
key: ${{ github.ref }}
|
|
path: .cache
|
|
|
|
- run: sudo apt-get install -y libcairo2-dev libfreetype6-dev libffi-dev libjpeg-dev libpng-dev libz-dev pngquant
|
|
- run: pip install mkdocs-git-revision-date-localized-plugin mkdocs-git-committers-plugin-2 mkdocs-git-authors-plugin mkdocs-material[imaging]
|
|
|
|
- name: Build Offline Version
|
|
run: make docs
|
|
|
|
- name: Zip Build
|
|
run: |
|
|
cd build/docs
|
|
zip -qq -r ../documentation.zip *
|
|
|
|
- name: Upload Artifacts
|
|
uses: actions/upload-artifact@v4.6.2
|
|
with:
|
|
name: Documentation
|
|
path: build/documentation.zip
|