s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Link to reference

Browse Source
This commit is contained in:
Dorota Czaplejewicz
2022-04-17 07:31:29 +00:00
parent c486ad1eb3
commit 71942f7221
2 changed files with 12 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/hacking.md
View File

@ -102,6 +102,17 @@ contain a comma separated list of:
Coding 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 ### Project structure
Rust modules should be split into 2 categories: libraries, and user interface. They differ in the way they do error handling. Rust modules should be split into 2 categories: libraries, and user interface. They differ in the way they do error handling.

1
doc/index.md
View File

@ -7,6 +7,7 @@ Contents
* [Tutorial](tutorial.md) * [Tutorial](tutorial.md)
* [Contributing](hacking.md) * [Contributing](hacking.md)
* [Switching views](views.md) * [Switching views](views.md)
* [Reference](doc/rs/)
Introduction Introduction
------------ ------------