document-features 0.2.12

Extract documentation for the feature flags from comments in Cargo.toml
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

name: Rust

on:
  push:
    branches: [ master ]
  pull_request:
    branches: [ master ]

env:
  CARGO_TERM_COLOR: always
  RUSTFLAGS: -D warnings
  RUST_BACKTRACE: 1

jobs:
  test:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        rust:
          - stable
          - 1.56.0
          - nightly

    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@master
        with:
          toolchain: ${{ matrix.rust }}
      - name: Run tests
        run: cargo test --verbose --all-features
      - name: Run docs
        run: cargo doc --verbose
  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@stable
      - name: Run rustfmt
        run: cargo fmt --all -- --check


  crater:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: dtolnay/rust-toolchain@master
        with:
          toolchain: nightly
      - name: setup patch
        run: |
          echo "" >> ~/.cargo/config.toml
          echo [patch.crates-io] >> ~/.cargo/config.toml
          echo document-features = { path = \"$GITHUB_WORKSPACE\" } >> ~/.cargo/config.toml
      - name: create project and generate docs
        run: |
          cd ~
          cargo new crater
          cd crater
          cargo add quick-xml -F document-features
          cargo add serde_with -F guide
          cargo add serial_test -F docsrs
          cargo add wgpu-core
          cargo add wgpu
          cargo add gix -F document-features
          cargo add kstring -F document-features
          cargo add ratatui -F document-features
          cargo add re_types
          cargo add slint -F document-features
          cargo add egui-winit -F document-features
          cargo add ehttp
          cargo add snapbox -F document-features
          cargo add fast-image-resize
          cargo add rhai -F document-features
          cargo add embassy-executor
          cargo add embassy-time

          cargo doc
          grep -r ">No documented features in Cargo.toml<" target/doc || exit 0
          false