Skip to content

Documenting - Rework doxygen documentation for markdawn #27

Documenting - Rework doxygen documentation for markdawn

Documenting - Rework doxygen documentation for markdawn #27

Workflow file for this run

# This workflow builds the OCCT reference manual and overview documentations.
# It is triggered on pushes to the 'master' branch.
# The workflow includes steps to checkout the repository, install dependencies, build the documentation, and upload the generated documentation and logs as artifacts.
name: Build Documentation
on:
pull_request:
branches:
- '**'
push:
branches:
- 'master'
jobs:
build:
name: Build Refman Documentation
runs-on: windows-2022
steps:
- name: Checkout repository
uses: actions/[email protected]
- name: Install dependencies
run: |
choco install -y graphviz
choco install -y doxygen.install
# - name: Build refman documentation
# run: |
# set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen
# cd adm
# bash gendoc -refman
# shell: cmd
# - name: Upload refman documentation
# uses: actions/[email protected]
# with:
# name: refman-doc
# path: doc/refman
# retention-days: 90
# - name: Upload generation log
# uses: actions/[email protected]
# with:
# name: doxygen.log
# path: doc/html_doxygen_err.log
# retention-days: 90
- name: Build documentation Overview
run: |
set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen
cd adm
bash gendoc -overview
shell: cmd
- name: Upload overview documentation
uses: actions/[email protected]
with:
name: overview-doc
path: doc/overview
retention-days: 90