File tree Expand file tree Collapse file tree 1 file changed +12
-12
lines changed Expand file tree Collapse file tree 1 file changed +12
-12
lines changed Original file line number Diff line number Diff line change 2
2
Welcome to SigMF!
3
3
=================
4
4
5
- **sigmf ** is a Python library for working with radio recordings captured in
6
- ``.sigmf `` format according to the `SigMF standard <https://sigmf.org/ >`_. It
7
- offers a *simple * and *intuitive * API for python developers.
5
+ **SigMF ** is a Python library for working with radio recordings in
6
+ ``.sigmf `` format according to the `SigMF standard <https://sigmf.org/ >`_.
7
+ It offers a *simple * and *intuitive * API for Python developers.
8
8
9
9
..
10
- Note below toolversion & specversion are replaced dynamically during build.
10
+ Note: The toolversion & specversion below are replaced dynamically during build.
11
11
12
- This version |toolversion | of the library coincides with version | specversion |
13
- of the specification.
12
+ This documentation is for version |toolversion | of the library, which is
13
+ compatible with version | specversion | of the SigMF specification.
14
14
15
- Check out the :doc: `quickstart ` section for further information, including
16
- how to :ref: `install ` the project.
15
+ To get started, see the :doc: `quickstart ` section or learn how to :ref: `install ` the library.
17
16
17
+ -----
18
18
19
19
.. toctree ::
20
20
:maxdepth: 1
21
+ :caption: Getting Started
21
22
:hidden:
22
- :caption: SigMF
23
23
24
24
quickstart
25
25
advanced
26
26
developers
27
27
28
28
.. toctree ::
29
29
:maxdepth: 1
30
- :hidden:
31
30
:caption: Community
31
+ :hidden:
32
32
33
33
faq
34
34
35
35
.. toctree ::
36
36
:maxdepth: 1
37
- :hidden:
38
37
:caption: API Reference
38
+ :hidden:
39
39
40
- api
40
+ api
You can’t perform that action at this time.
0 commit comments