Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add api docs to the generated docs site #344

Merged
merged 1 commit into from
Nov 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,21 @@ jobs:
- name: Checkout sources
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11

- name: Install rust
uses: actions-rs/toolchain@v1
with:
toolchain: stable
override: true

- name: Build docs
run: cargo doc -p statime --lib --no-deps

- name: Build site
run: utils/mkdocs.sh --no-bind-port build

- name: Copy API docs
run: cp -R target/doc target/docs/site/api

- name: Upload artifact
uses: actions/upload-pages-artifact@a753861a5debcf57bf8b404356158c8e1e33150c
with:
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,4 @@ nav:
- guide/getting-started.md
- Man Pages:
- statime(8): man/statime.8.md
- statime.toml(5): man/statime.toml.5.md
Loading