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

creating developers chapter in md book #103

Merged
merged 3 commits into from
Jul 2, 2024
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
1 change: 1 addition & 0 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
- [Documentation](./fastsim-doc.md)
- [Python](./python-doc.md)
- [Rust](./rust-doc.md)
- [Developers](./developers.md)
- [Calibration/Validation](./cal_and_val.md)
- [How to Update This Book](./how-to-update.md)
- [Release Notes](./release-notes.md)
11 changes: 11 additions & 0 deletions docs/src/developers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# How to compile/test Rust code

## cargo build
`cargo build` will not compile when run in `/rust` due to problems compiling `/rust/fastsim-py`.
`cargo build` should compile when run in the `/rust/fastsim-core`.

## cargo test
`cargo test` should compile when run in /rust because there are no tests in `/rust/fastsim-py`.

## build_and_test.sh
Running `sh build_and_test.sh` from the root fastsim directory compile/tests the Rust code, and tests the Python code. It should compile without errors.
4 changes: 3 additions & 1 deletion docs/src/fastsim-doc.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,6 @@

## [Python](./python-doc.md)

## [Rust](./rust-doc.md)
## [Rust](./rust-doc.md)

## [Developers](./developers.md)
6 changes: 3 additions & 3 deletions docs/src/how-to-update.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Run the following in the repository root directory:

## Publishing
1. Update `book.toml` or files in `docs/src/`
1. Make sure the docs look good locally by running the steps in [Serving Locally](#serving-locally)
1. Commit files and push to `main` branch
1. Make sure the docs look good locally by running the steps in [Serving Locally](#serving-locally).
1. Commit files and push to `fastsim-2` branch

After that, a GitHub action will build the book and publish it.
After that, a GitHub action will build the book and publish it.
Loading