This repository was archived by the owner on Feb 7, 2025. It is now read-only.
File tree Expand file tree Collapse file tree 1 file changed +66
-0
lines changed Expand file tree Collapse file tree 1 file changed +66
-0
lines changed Original file line number Diff line number Diff line change 1+ # Combination of https://github.com/RobinMagnet/pyFM/blob/master/.github/workflows/documentation.yml
2+ # https://github.com/r-lib/pkgdown/blob/main/.github/workflows/pkgdown.yaml
3+ # and https://github.com/DenverCoder1/doxygen-github-pages-action
4+ name : docs
5+
6+ on :
7+ push :
8+ branches : [main]
9+ pull_request :
10+ branches : [main]
11+ release :
12+ types : [published]
13+ workflow_dispatch :
14+
15+ jobs :
16+ build_documentation :
17+ name : Build Documentation
18+ runs-on : ubuntu-latest
19+
20+ permissions :
21+ contents : write
22+
23+ steps :
24+ - name : Checkout repository
25+ uses : actions/checkout@v4
26+ with :
27+ repository : ' StochasticTree/stochtree'
28+ ref : ' cpp_docs'
29+ submodules : ' recursive'
30+
31+ - name : Setup Python 3.10
32+ uses : actions/setup-python@v5
33+ with :
34+ python-version : " 3.10"
35+ cache : " pip"
36+
37+ - name : Install Package with Relevant Dependencies
38+ run : |
39+ pip install --upgrade pip
40+ pip install -r cpp_docs/requirements.txt
41+ pip install .
42+
43+ - name : Install doxygen and graphviz
44+ run : |
45+ sudo apt-get install doxygen graphviz -y
46+
47+ - name : Build doxygen XML files
48+ run : |
49+ doxygen cpp_docs/Doxyfile
50+
51+ - name : Build HTML
52+ run : |
53+ sphinx-build -M html cpp_docs/ cpp_docs/_build/
54+
55+ - name : Upload Artifact
56+ uses : actions/upload-artifact@v4
57+ with :
58+ path :
59+ cpp_docs/_build/html/
60+
61+ - name : Deploy to GitHub Pages
62+ uses : peaceiris/actions-gh-pages@v4
63+ if : github.ref == 'refs/heads/main'
64+ with :
65+ github_token : ${{ secrets.GITHUB_TOKEN }}
66+ publish_dir : cpp_docs/_build/html
You can’t perform that action at this time.
0 commit comments