Skip to content

Commit 95331b6

Browse files
committed
Add C++ API documentation
- add GitHub Actions workflow for deploying pages - add setup for sphinx + breath to format Doxygen generated documentation - add pages for molecule, basis set, grid, runtime environment, load balancer, xc integrator and macros - update header files with doxygen-style comments to display documentation
1 parent 62fea07 commit 95331b6

24 files changed

Lines changed: 1452 additions & 104 deletions

.github/workflows/docs.yml

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Docs
2+
3+
on:
4+
push:
5+
branches: [master, docs]
6+
workflow_dispatch:
7+
8+
permissions:
9+
contents: read
10+
pages: write
11+
id-token: write
12+
13+
concurrency:
14+
group: pages
15+
cancel-in-progress: false
16+
17+
jobs:
18+
build:
19+
runs-on: ubuntu-latest
20+
21+
steps:
22+
- name: Checkout repository
23+
uses: actions/checkout@v5
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v6
27+
with:
28+
python-version: '3.13'
29+
cache: 'pip'
30+
31+
- name: Install dependencies
32+
run: pip install -r docs/requirements.txt
33+
34+
- name: Install Doxygen
35+
run: |
36+
sudo apt-get update
37+
sudo apt-get install -y doxygen
38+
39+
- name: Generate Doxygen
40+
run: |
41+
doxygen Doxyfile
42+
working-directory: ./docs
43+
44+
- name: Build documentation
45+
run: |
46+
sphinx-build -b dirhtml docs docs/_build/html
47+
touch docs/_build/html/.nojekyll
48+
49+
- name: Upload Pages artifact
50+
uses: actions/upload-pages-artifact@v3
51+
with:
52+
path: docs/_build/html
53+
54+
deploy:
55+
needs: build
56+
runs-on: ubuntu-latest
57+
environment:
58+
name: github-pages
59+
url: ${{ steps.deploy.outputs.page_url }}
60+
61+
steps:
62+
- name: Deploy to GitHub Pages
63+
id: deploy
64+
uses: actions/deploy-pages@v4

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_doxygen/

0 commit comments

Comments
 (0)