diff options
| author | Marco Ieni <11428655+MarcoIeni@users.noreply.github.com> | 2021-04-16 00:18:16 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-04-15 18:18:16 -0400 |
| commit | feb8b12ea1af91947a2dd05e0bb94373a5292e14 (patch) | |
| tree | 8af756484ce957cdb47433e32f16c148a51d4760 /.github | |
| parent | e7d1e281ea539adb91a57c6945dea123fff1bd16 (diff) | |
CI: check docs (#559)
* CI: check docs
* Don't use triple-slash doc comments
A full pass would need to be done to make the comments suitable for
generating documentation.
Co-authored-by: Dan Davison <dandavison7@gmail.com>
Diffstat (limited to '.github')
| -rw-r--r-- | .github/workflows/ci.yml | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index c78ae786..7f3320f7 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -109,6 +109,26 @@ jobs: command: clippy args: -- -D warnings + docs: + name: Docs + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v2 + - name: Install Rust + uses: actions-rs/toolchain@v1 + with: + toolchain: stable + profile: minimal + override: true + - name: Check documentation + env: + RUSTDOCFLAGS: -D warnings + uses: actions-rs/cargo@v1 + with: + command: doc + args: --no-deps --document-private-items + coverage: name: Code coverage runs-on: ubuntu-latest |