docs: Link to reference

2022-04-17 07:31:29 +00:00
parent c486ad1eb3
commit 71942f7221
2 changed files with 12 additions and 0 deletions
--- 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.