mirror of
https://github.com/Magnus167/rustframe.git
synced 2025-08-20 04:30:01 +00:00
Compare commits
6 Commits
1dcd9727b4
...
ecd06eb352
Author | SHA1 | Date | |
---|---|---|---|
![]() |
ecd06eb352 | ||
![]() |
ae327b6060 | ||
![]() |
83ac9d4821 | ||
![]() |
ae27ed9373 | ||
![]() |
c7552f2264 | ||
![]() |
3654c7053c |
6
.github/workflows/docs-and-testcov.yml
vendored
6
.github/workflows/docs-and-testcov.yml
vendored
@ -170,10 +170,8 @@ jobs:
|
|||||||
|
|
||||||
- name: Build user guide
|
- name: Build user guide
|
||||||
run: |
|
run: |
|
||||||
cargo binstall mdbook -q
|
cargo binstall mdbook
|
||||||
cd docs
|
bash ./docs/build.sh
|
||||||
./build.sh
|
|
||||||
cd ..
|
|
||||||
|
|
||||||
- name: Copy user guide to output directory
|
- name: Copy user guide to output directory
|
||||||
run: |
|
run: |
|
||||||
|
6
.github/workflows/run-unit-tests.yml
vendored
6
.github/workflows/run-unit-tests.yml
vendored
@ -81,7 +81,5 @@ jobs:
|
|||||||
|
|
||||||
- name: Test build user guide
|
- name: Test build user guide
|
||||||
run: |
|
run: |
|
||||||
cargo binstall mdbook -q
|
cargo binstall mdbook
|
||||||
cd docs
|
bash ./docs/build.sh
|
||||||
./build.sh
|
|
||||||
cd ..
|
|
||||||
|
11
README.md
11
README.md
@ -198,3 +198,14 @@ To run the benchmarks, use:
|
|||||||
```bash
|
```bash
|
||||||
cargo bench --features "bench"
|
cargo bench --features "bench"
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Building the user-guide
|
||||||
|
|
||||||
|
To build the user guide, use:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cargo binstall mdbook
|
||||||
|
bash docs/build.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
This will generate the user guide in the `docs/book` directory.
|
||||||
|
@ -1,15 +1,7 @@
|
|||||||
#!/usr/bin/env sh
|
#!/usr/bin/env sh
|
||||||
# Build and test the RustFrame user guide using mdBook.
|
# Build and test the RustFrame user guide using mdBook.
|
||||||
set -e
|
set -e
|
||||||
# Ensure the library is compiled so examples can link against it.
|
|
||||||
|
|
||||||
cargo clean
|
cd docs
|
||||||
|
bash gen.sh "$@"
|
||||||
cargo build --manifest-path ../Cargo.toml
|
cd ..
|
||||||
# Run embedded code examples as tests.
|
|
||||||
mdbook test -L ../target/debug/deps "$@"
|
|
||||||
# Finally, render the book.
|
|
||||||
mdbook build "$@"
|
|
||||||
|
|
||||||
cargo build
|
|
||||||
cargo build --release
|
|
14
docs/gen.sh
Normal file
14
docs/gen.sh
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
#!/usr/bin/env sh
|
||||||
|
|
||||||
|
set -e
|
||||||
|
|
||||||
|
cargo clean
|
||||||
|
|
||||||
|
cargo build --manifest-path ../Cargo.toml
|
||||||
|
|
||||||
|
mdbook test -L ../target/debug/deps "$@"
|
||||||
|
|
||||||
|
mdbook build "$@"
|
||||||
|
|
||||||
|
cargo build
|
||||||
|
cargo build --release
|
@ -4,12 +4,7 @@ Welcome to the **RustFrame User Guide**. This book provides a tour of
|
|||||||
RustFrame's capabilities from basic data handling to advanced machine learning
|
RustFrame's capabilities from basic data handling to advanced machine learning
|
||||||
workflows. Each chapter contains runnable snippets so you can follow along.
|
workflows. Each chapter contains runnable snippets so you can follow along.
|
||||||
|
|
||||||
To build this guide locally run `./build.sh` in the `docs/` directory. The
|
|
||||||
chapters are arranged sequentially:
|
|
||||||
|
|
||||||
1. [Data manipulation](./data-manipulation.md) for loading and transforming data.
|
1. [Data manipulation](./data-manipulation.md) for loading and transforming data.
|
||||||
2. [Compute features](./compute.md) for statistics and analytics.
|
2. [Compute features](./compute.md) for statistics and analytics.
|
||||||
3. [Machine learning](./machine-learning.md) for predictive models.
|
3. [Machine learning](./machine-learning.md) for predictive models.
|
||||||
4. [Utilities](./utilities.md) for supporting helpers and upcoming modules.
|
4. [Utilities](./utilities.md) for supporting helpers and upcoming modules.
|
||||||
|
|
||||||
Let's begin with some tabular data!
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user