Skip to content

Commit 1a0224a

Browse files
committed
docs: reorganize documentation
Signed-off-by: Ajay Bhargav <[email protected]>
1 parent 274bf3a commit 1a0224a

File tree

14 files changed

+52
-28
lines changed

14 files changed

+52
-28
lines changed

docs/book/api/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ API Reference Guide
44
.. toctree::
55
:maxdepth: 2
66

7-
Network API <net/index>
7+
System <system/index>
88
Peripherals <peri/index>
9+
Network API <net/index>
910
Protocols <proto/index>
1011
Drivers <drivers/index>
1112
Storage <storage/index>
12-
System <system/index>
1313
Utilities <utils/index>
1414
Cryptography <crypto/index>
1515

docs/book/api/net/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Network API
88
RAW Socket API <socket>
99
BSD Socket API <bsd_socket>
1010
Modem Interface APIs <modem>
11-
Radio Interface Layer - RIL <ril>
11+
Radio Interface Layer (RIL) <ril>

docs/book/api/net/ril.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
Radio Interface Layer - RIL
22
===========================
33

4-
.. include:: /inc/ril.inc
4+
.. toctree::
5+
:maxdepth: 1
6+
7+
RIL API <ril/ril>
8+
SIM Toolkit Interface <ril/stk>
59

docs/book/api/net/ril/ril.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
RIL API
2+
=======
3+
4+
.. include:: /inc/ril.inc
5+

docs/book/api/net/ril/stk.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
SIM Toolkit Interface
2+
=====================
3+
4+
.. include:: /inc/ril_stk.inc
5+
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
GNSS Hardware API
2+
=================
3+
4+
.. note:: For Neoway N58 and Quectel EC200U-CNAA module only.
5+
6+
.. include:: /inc/gnss.inc
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
GPS Driver Interface API
2+
========================
3+
4+
.. include:: /inc/gpsdriver.inc
5+
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
GPS Library API
2+
===============
3+
4+
.. include:: /inc/gpslib.inc
5+

docs/book/api/peri/gps.rst

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
GPS Library
22
===========
33

4-
.. toctree::
5-
:maxdepth: 2
6-
74
Logicrom gps library does all the heavy lifting and makes it easy to use
85
and interface any GNSS module. Features of gps library:
96

@@ -53,19 +50,9 @@ Following are the supported chipset or modules:
5350
* Quectel EC200UCN-AA LTE Cat.1 Module
5451

5552

56-
GPS Library API
57-
---------------
58-
59-
.. include:: /inc/gpslib.inc
60-
61-
GPS Driver Interface API
62-
------------------------
63-
64-
.. include:: /inc/gpsdriver.inc
65-
66-
GNSS Hardware API
67-
-----------------
68-
69-
.. note:: For Neoway N58 and Quectel EC200U modules only.
53+
.. toctree::
54+
:maxdepth: 1
7055

71-
.. include:: /inc/gnss.inc
56+
GNSS Hardware <gnss/gnss_hardware>
57+
GPS Library <gnss/gps_lib>
58+
GPS Driver <gnss/gps_driver>

docs/book/api/system/index.rst

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ System
55
:maxdepth: 1
66

77
Logicrom Library <logicrom>
8-
OS API <os>
8+
RTOS Interface <rtos>
99
System Calls <syscall>
10-
Task Timers <task_timer>
11-
Timers <timers>
1210
FOTA API <fota>
1311
Command Processor <command_proc>
14-
Message Queue <messageq>
12+
Message Queue <messageq>

0 commit comments

Comments
 (0)