Skip to content

Commit f928217

Browse files
committed
polish index a bit
1 parent b3d01c4 commit f928217

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

docs/source/index.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,39 +2,39 @@
22
Welcome to SigMF!
33
=================
44

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.
88

99
..
10-
Note below toolversion & specversion are replaced dynamically during build.
10+
Note: The toolversion & specversion below are replaced dynamically during build.
1111
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.
1414

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.
1716

17+
-----
1818

1919
.. toctree::
2020
:maxdepth: 1
21+
:caption: Getting Started
2122
:hidden:
22-
:caption: SigMF
2323

2424
quickstart
2525
advanced
2626
developers
2727

2828
.. toctree::
2929
:maxdepth: 1
30-
:hidden:
3130
:caption: Community
31+
:hidden:
3232

3333
faq
3434

3535
.. toctree::
3636
:maxdepth: 1
37-
:hidden:
3837
:caption: API Reference
38+
:hidden:
3939

40-
api
40+
api

0 commit comments

Comments
 (0)