2021-07-15 19:28:19 +08:00
|
|
|
This folder represents the Github Pages site that is used to host Stabilizer's user guide.
|
|
|
|
|
|
|
|
|
|
The site is hosted with Jekyll and utilizes the "Just the Docs" theme.
|
|
|
|
|
|
|
|
|
|
To run locally:
|
|
|
|
|
1. Install Ruby
|
|
|
|
|
1. Install [Jekyll](https://jekyllrb.com/)
|
|
|
|
|
1. Install [Bundler](https://bundler.io/)
|
|
|
|
|
1. From this directory:
|
|
|
|
|
```
|
|
|
|
|
bundle install
|
|
|
|
|
bundle exec jekyll serve
|
|
|
|
|
```
|
2021-07-16 20:25:37 +08:00
|
|
|
1. Navigate to `localhost:4000/stabilizer/` in a web browser
|
2021-07-15 19:28:19 +08:00
|
|
|
|
|
|
|
|
Note: Some of the links in the docs rely on Cargo's documentation. To make all links work locally, run:
|
|
|
|
|
```
|
2021-07-16 20:25:37 +08:00
|
|
|
cargo doc --no-deps -p dsp -p miniconf -p stabilizer -p ad9959
|
2021-07-15 19:28:19 +08:00
|
|
|
cp -r target/thumbv7em-none-eabihf/doc docs/firmware
|
|
|
|
|
```
|
