Skip to content
This repository was archived by the owner on Nov 5, 2024. It is now read-only.

Commit 140b690

Browse files
committed
add doxygen publish action
1 parent afc72b8 commit 140b690

File tree

2 files changed

+44
-2
lines changed

2 files changed

+44
-2
lines changed

.github/workflows/doxygen.yml

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: doxygen
2+
3+
on:
4+
push:
5+
branches: [ master ]
6+
7+
env:
8+
CARGO_TERM_COLOR: always
9+
10+
defaults:
11+
run:
12+
shell: bash
13+
14+
jobs:
15+
doxygen:
16+
name: doxygen
17+
runs-on: ubuntu-latest
18+
env:
19+
BUILD_ENV: debug
20+
TARGET: x86_64-unknown-linux-gnu
21+
steps:
22+
- name: install rust
23+
uses: actions-rs/toolchain@v1
24+
with:
25+
profile: minimal
26+
toolchain: stable
27+
target: x86_64-unknown-linux-gnu
28+
override: true
29+
30+
- name: checkout
31+
uses: actions/checkout@v2
32+
33+
- name: install doxygen
34+
run: sudo apt-get install doxygen
35+
36+
- name: generate docs
37+
run: make doxygen
38+
39+
- name: deploy to GH pages
40+
uses: peaceiris/actions-gh-pages@v3
41+
with:
42+
github_token: ${{ secrets.GITHUB_TOKEN }}
43+
publish_dir: ./docs/html

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,11 @@
44

55
All classes/methods are defined under `lib_ruby_parser` namespace. API mostly mirrors Rust version.
66

7-
Pre-compiled library and header file are available on [Releases](https://github.com/lib-ruby-parser/cpp-bindings/releases), supported platforms:
7+
Pre-compiled libraries and header files are available on [Releases](https://github.com/lib-ruby-parser/cpp-bindings/releases), supported platforms:
88

99
+ `x86_64-apple-darwin`
1010
+ `x86_64-unknown-linux-gnu`
1111
+ `x86_64-pc-windows-msvc`
12-
+ `x86_64-pc-windows-gnu`
1312

1413
## Basic API
1514

0 commit comments

Comments
 (0)