|
| 1 | +# Licensed to the Apache Software Foundation (ASF) under one |
| 2 | +# or more contributor license agreements. See the NOTICE file |
| 3 | +# distributed with this work for additional information |
| 4 | +# regarding copyright ownership. The ASF licenses this file |
| 5 | +# to you under the Apache License, Version 2.0 (the |
| 6 | +# "License"); you may not use this file except in compliance |
| 7 | +# with the License. You may obtain a copy of the License at |
| 8 | +# |
| 9 | +# http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | +# |
| 11 | +# Unless required by applicable law or agreed to in writing, |
| 12 | +# software distributed under the License is distributed on an |
| 13 | +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 14 | +# KIND, either express or implied. See the License for the |
| 15 | +# specific language governing permissions and limitations |
| 16 | +# under the License. |
| 17 | + |
| 18 | +name: Docs |
| 19 | + |
| 20 | +on: |
| 21 | + # always trigger |
| 22 | + push: |
| 23 | + pull_request: |
| 24 | + |
| 25 | +jobs: |
| 26 | + |
| 27 | + # test doc links still work |
| 28 | + docs: |
| 29 | + name: Rustdocs are clean |
| 30 | + runs-on: ubuntu-latest |
| 31 | + strategy: |
| 32 | + matrix: |
| 33 | + arch: [ amd64 ] |
| 34 | + rust: [ nightly ] |
| 35 | + container: |
| 36 | + image: ${{ matrix.arch }}/rust |
| 37 | + env: |
| 38 | + RUSTDOCFLAGS: "-Dwarnings" |
| 39 | + steps: |
| 40 | + - uses: actions/checkout@v2 |
| 41 | + with: |
| 42 | + submodules: true |
| 43 | + - name: Install python dev |
| 44 | + run: | |
| 45 | + apt update |
| 46 | + apt install -y libpython3.9-dev |
| 47 | + - name: Setup Rust toolchain |
| 48 | + uses: ./.github/actions/setup-builder |
| 49 | + with: |
| 50 | + rust-version: ${{ matrix.rust }} |
| 51 | + - name: Run cargo doc |
| 52 | + run: | |
| 53 | + cargo doc --document-private-items --no-deps --workspace --all-features |
0 commit comments