Add in hidden doctests for our format API. #3
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Docs | |
| on: | |
| [workflow_dispatch, pull_request] | |
| jobs: | |
| docs: | |
| name: Test Docs Combinations | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - name: Install latest nightly | |
| uses: dtolnay/rust-toolchain@nightly | |
| - run: cargo --version | |
| - run: python --version | |
| - run: cargo check | |
| - run: cargo build | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features --features=format | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features --features=radix | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features --features=format,radix | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features --features=write-integers,write-floats | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features --features=parse-integers,parse-floats | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --no-default-features --all-features | |
| # validate all the generated docs.rs docs | |
| - run: RUSTDOCFLAGS="-D warnings --cfg docsrs" cargo doc --features=format,radix | |
| # NOTE: We currently skip the links since the validation is iffy | |
| # and it takes a long time. | |
| - run: SKIP_LINKS=1 python scripts/docs.py |