Skip to content

Commit d62d922

Browse files
committed
ci: check docs generation
1 parent 435c89e commit d62d922

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

.github/workflows/main.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,3 +67,27 @@ jobs:
6767
cd $GITHUB_WORKSPACE
6868
python ci/build_and_run_tests.py
6969
shell: bash
70+
# Detect cases where documentation links don't resolve and such.
71+
doc:
72+
name: Docs
73+
runs-on: ubuntu-latest
74+
steps:
75+
- uses: actions/checkout@v2
76+
with:
77+
submodules: 'recursive'
78+
- uses: actions-rs/toolchain@v1
79+
with:
80+
profile: minimal
81+
# Docs.rs uses nightly, which allows for easier syntax for linking to functions.
82+
toolchain: nightly
83+
override: true
84+
- uses: actions-rs/cargo@v1
85+
with:
86+
# Need to use `cargo rustdoc` to actually get it to respect -D
87+
# warnings... Note: this also requires nightly.
88+
command: rustdoc
89+
args: -p couchbase-lite -- -D warnings
90+
- uses: actions-rs/cargo@v1
91+
with:
92+
command: rustdoc
93+
args: -p couchbase-lite-core-sys -- -D warnings

0 commit comments

Comments
 (0)