nsip 0.4.0

NSIP Search API client for nsipsearch.nsip.org/api
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120

name: Deploy Documentation

on:
  # push:
  #   branches: [main, master]
  #   paths:
  #     - 'docs/**'
  #     - 'src/**/*.rs'
  #     - 'Cargo.toml'
  # release:
  #   types: [published]
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  build-docs:
    name: Build Documentation
    runs-on: ubuntu-latest
    timeout-minutes: 20
    
    steps:
      - name: Checkout code
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2

      - name: Setup Rust with caching
        uses: ./.github/actions/setup-rust-cached
        with:
          toolchain: stable
          cache-key: docs

      - name: Build rustdoc
        run: |
          cargo doc --no-deps --all-features
          echo '<meta http-equiv="refresh" content="0; url=rust_template">' > target/doc/index.html

      - name: Install mdBook
        uses: ./.github/actions/install-cargo-tool
        with:
          tool: mdbook@0.4.40

      - name: Build mdBook (if exists)
        run: |
          if [ -f "book.toml" ]; then
            mdbook build
            mkdir -p target/doc/book
            cp -r book/* target/doc/book/
          fi

      - name: Create index page
        run: |
          cat > target/doc/landing.html << 'HTML'
          <!DOCTYPE html>
          <html>
          <head>
              <title>rust-template Documentation</title>
              <style>
                  body { font-family: sans-serif; max-width: 800px; margin: 50px auto; padding: 20px; }
                  h1 { color: #333; }
                  .section { margin: 30px 0; padding: 20px; border: 1px solid #ddd; border-radius: 5px; }
                  a { color: #0066cc; text-decoration: none; }
                  a:hover { text-decoration: underline; }
              </style>
          </head>
          <body>
              <h1>rust-template Documentation</h1>
              
              <div class="section">
                  <h2>API Documentation</h2>
                  <p><a href="rust_template/index.html">Browse API docs</a></p>
              </div>
              
              <div class="section">
                  <h2>Guides</h2>
                  <ul>
                      <li><a href="book/index.html">User Guide</a> (if mdBook configured)</li>
                      <li><a href="https://github.com/${{ github.repository }}/tree/main/docs">Documentation Directory</a></li>
                  </ul>
              </div>
              
              <div class="section">
                  <h2>Resources</h2>
                  <ul>
                      <li><a href="https://github.com/${{ github.repository }}">GitHub Repository</a></li>
                      <li><a href="https://crates.io/crates/rust_template">crates.io</a></li>
                  </ul>
              </div>
          </body>
          </html>
          HTML
          cp target/doc/landing.html target/doc/index.html

      - name: Setup Pages
        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0

      - name: Upload artifact
        uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0
        with:
          path: target/doc

  deploy:
    name: Deploy to GitHub Pages
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    timeout-minutes: 10
    needs: build-docs
    
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5