diff --git a/doc/hacking.md b/doc/hacking.md index 6db78b68..70301a2c 100644 --- a/doc/hacking.md +++ b/doc/hacking.md @@ -102,6 +102,17 @@ contain a comma separated list of: Coding ------ +### Reference docs + +Reference documentation can be generated using: + +``` +cd squeekboard_build/ +../squeekboard_source/cargo.sh doc --no-deps --document-private-items +``` + +as well as found [online](https://world.pages.gitlab.gnome.org/Phosh/squeekboard/doc/rs/). + ### Project structure Rust modules should be split into 2 categories: libraries, and user interface. They differ in the way they do error handling. diff --git a/doc/index.md b/doc/index.md index fdf4dcbe..25b841cf 100644 --- a/doc/index.md +++ b/doc/index.md @@ -7,6 +7,7 @@ Contents * [Tutorial](tutorial.md) * [Contributing](hacking.md) * [Switching views](views.md) +* [Reference](doc/rs/) Introduction ------------