diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md index ad54dcab..5c5a7c65 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -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) diff --git a/docs/src/developers.md b/docs/src/developers.md new file mode 100644 index 00000000..8bacb111 --- /dev/null +++ b/docs/src/developers.md @@ -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. \ No newline at end of file diff --git a/docs/src/fastsim-doc.md b/docs/src/fastsim-doc.md index 565f42dc..dfa9a59e 100644 --- a/docs/src/fastsim-doc.md +++ b/docs/src/fastsim-doc.md @@ -2,4 +2,6 @@ ## [Python](./python-doc.md) -## [Rust](./rust-doc.md) \ No newline at end of file +## [Rust](./rust-doc.md) + +## [Developers](./developers.md) \ No newline at end of file diff --git a/docs/src/how-to-update.md b/docs/src/how-to-update.md index 2b0e16c1..5b6ac372 100644 --- a/docs/src/how-to-update.md +++ b/docs/src/how-to-update.md @@ -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. \ No newline at end of file +After that, a GitHub action will build the book and publish it.