Skip to content

Commit a90d421

Browse files
Copilotsfxfs
andauthored
Optimize mjsonrpc.h with comprehensive doxygen documentation and add automated documentation workflow (#3)
* Initial plan * Optimize mjsonrpc.h with comprehensive doxygen documentation and add doxygen workflow Co-authored-by: sfxfs <39017816+sfxfs@users.noreply.github.com> * Remove backup file generated during doxygen config update Co-authored-by: sfxfs <39017816+sfxfs@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: sfxfs <39017816+sfxfs@users.noreply.github.com>
1 parent 3f0e26a commit a90d421

File tree

4 files changed

+3272
-71
lines changed

4 files changed

+3272
-71
lines changed

.github/workflows/docs.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: Generate Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
docs:
11+
runs-on: ubuntu-latest
12+
13+
steps:
14+
- name: Checkout code
15+
uses: actions/checkout@v4
16+
17+
- name: Install Doxygen
18+
run: sudo apt-get update && sudo apt-get install -y doxygen graphviz
19+
20+
- name: Generate Documentation
21+
run: doxygen Doxyfile
22+
23+
- name: Upload Documentation Artifacts
24+
uses: actions/upload-artifact@v4
25+
with:
26+
name: documentation
27+
path: docs/html/
28+
retention-days: 30
29+
30+
- name: Deploy to GitHub Pages
31+
if: github.ref == 'refs/heads/main' && github.event_name == 'push'
32+
uses: peaceiris/actions-gh-pages@v3
33+
with:
34+
github_token: ${{ secrets.GITHUB_TOKEN }}
35+
publish_dir: ./docs/html
36+
force_orphan: true

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,3 +57,6 @@ build*/
5757
output/
5858
Testing/
5959
.DS_Store
60+
61+
# Doxygen generated documentation
62+
docs/

0 commit comments

Comments
 (0)