Sojus07/hackrf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentaiton based on PR changes requested

Browse Source
This commit is contained in:
straithe
2022-10-28 15:37:40 -04:00
parent 23a092f444
commit e1e95b0dc9
3 changed files with 6 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/source/index.rst
View File

@ -4,9 +4,10 @@ Welcome to HackRF's documentation!
.. toctree::
:maxdepth: 2
:caption: HackRF User Documentation
:caption: User Documentation
hackrf_one
jawbreaker
faq
troubleshooting
getting_help
@ -56,8 +57,3 @@ Welcome to HackRF's documentation!
opera_cake_port_configuration
opera_cake_modes_of_operation
.. toctree::
:maxdepth: 2
:caption: Jawbreaker Documentation
jawbreaker

2
docs/source/opera_cake_modes_of_operation.rst
View File

@ -7,7 +7,7 @@ Opera Cake supports three modes of operation: ``manual``, ``frequency``, and ``t
Manual Mode
~~~~~~~~~~~
The default mode of operation is ``manual``. In manual mode, fixed port connections are configured with the ``-a`` and ``-b`` options as in the port configuration examples above. If the operating mode has been changed, it can be changed back to manual mode with:
The default mode of operation is ``manual``. In manual mode, fixed port connections are configured with the ``-a`` and ``-b`` options as in the :ref:`port configuration examples <portconfiguration>`. If the operating mode has been changed, it can be changed back to manual mode with:
.. code-block:: sh

2
docs/source/opera_cake_port_configuration.rst
View File

@ -1,3 +1,5 @@
.. _portconfiguration:
===================
Port Configurations
===================