Skip to content

Commit 9709510

Browse files
jonnewjonnew
committed
Fix broken links and formatting
1 parent 365a821 commit 9709510

File tree

4 files changed

+49
-49
lines changed

4 files changed

+49
-49
lines changed

‎source/Software Guide/OpenEphys.Onix1/index.rst

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,12 @@
33
Bonsai ONIX Package
44
=================================
55

6-
`OpenEphys.Onix1
7-
<https://open-ephys.github.io/onix1-bonsai-docs/index.html>`__ is the `Bonsai <https://bonsai-rx.org/>`__
8-
package for ONIX hardware. This package contains `Bonsai Operators
6+
``OpenEphys.Onix1`` is a `Bonsai <https://bonsai-rx.org/>`__ package for ONIX
7+
hardware. This package contains `Bonsai Operators
98
<https://bonsai-rx.org/docs/articles/operators.html>`__ for acquiring and
109
sending data to ONIX hardware.
1110

12-
:Code: https://github.com/open-ephys/bonsai-onix1
11+
:Code: https://github.com/open-ephys/bonsai-onix1
1312
:Compatibility: All ONIX hardware, Neuropixels, UCLA miniscopes & variants
1413
:Documentation: https://open-ephys.github.io/bonsai-onix1-docs/index.html
1514

@@ -18,7 +17,7 @@ sending data to ONIX hardware.
1817
<a href="https://open-ephys.github.io/bonsai-onix1-docs/index.html"><span class="std std-ref custom-card">
1918
<div class="card text-center page-card">
2019

21-
<header>
20+
<header>
2221
<h1>Go to the OpenEphys.Onix1 Docs <i class="fas fa-external-link"></i></h1>
2322
</header>
2423
<img src="../../_static/images/bonsai-lettering.svg"
@@ -44,4 +43,4 @@ combining it with third-party data sources (e.g. machine vision cameras,
4443
behavioral hardware, etc.), and for real-time processing and manipulation of
4544
data streams. The documentation linked above contains detailed instructions on
4645
how to use Bonsai with ONIX hardware along with fully useable example workflows,
47-
data loading scripts, etc.
46+
data loading scripts, etc.

‎source/Software Guide/index.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@
2020
for real-time experiments. Bonsai is very good at processing the
2121
heterogeneous data streams produced by ONIX hardware.
2222

23-
:ref:`Open Ephys GUI ONIX Plugin<open_ephys_gui>`
24-
The `Open Ephys GUI <https://open-ephys.github.io/gui-docs/> excels at
23+
:ref:`Open Ephys GUI ONIX Plugin <open_ephys_gui>`
24+
The `Open Ephys GUI <https://open-ephys.github.io/gui-docs/>` excels at
2525
electrophysiology data visualization and recording.
2626

27-
:ref:`oni-repl <oni_repl>`
28-
A simple command-line application that can be used for debugging and basic
29-
streaming IO with ONIX hardware.
27+
:ref:`Command line application <oni_repl>`
28+
`oni-repl` is a simple command-line application that can be used for
29+
debugging and basic streaming IO with ONIX hardware.
3030

3131
.. tip:: ONIX uses an `ONI-compliant API
3232
<https://open-ephys.github.io/ONI/api/index.html>`__ that is software

‎source/Software Guide/oni-repl/index.rst

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
.. _oni_repl:
22

3-
oni-repl
3+
Command Line Application
44
===================================
55

66
.. toctree::
7+
:hidden:
78
:maxdepth: 1
89

910
usage
@@ -33,11 +34,11 @@ hardware to perform the following:
3334
- Bulk initialize device register state
3435

3536
.. note:: ``oni-repl`` was created for hardware debugging and as a test program
36-
for `liboni <https://open-ephys.github.io/ONI/api/liboni/index.html>`__.
37-
However, its simplicity and lack of abstraction compared to
38-
:ref:`bonsai_onixref` make it useful as an example of how to use
39-
`liboni <https://open-ephys.github.io/ONI/api/liboni/index.html>`__ and
40-
for quickly examining hardware state and hub firmware versions.
37+
for `liboni <https://open-ephys.github.io/ONI/api/liboni/index.html>`__.
38+
However, its simplicity and lack of abstraction compared to
39+
:ref:`bonsai_onixref` make it useful as an example of how to use `liboni
40+
<https://open-ephys.github.io/ONI/api/liboni/index.html>`__ and for quickly
41+
examining hardware state and hub firmware versions.
4142

4243
.. code-block:: none
4344

‎source/Software Guide/oni-repl/usage.rst

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,19 @@
11
.. _oni_repl_usage:
22

3-
Usage
3+
``oni-repl`` Usage
44
====================================
55

66
.. code-block:: console
77
8-
oni-repl <driver> [slot] [-d] [-D <value>] [-n <value>] [-i <device index>]
9-
[--rbytes=<bytes>] [--wbytes=<bytes>] [--dumppath=<path>] [-h,--help] [-v,--version]
8+
oni-repl <driver> [slot] [-d] [-D <value>] [-n <value>] [-i <device index>]
9+
[--rbytes=<bytes>] [--wbytes=<bytes>] [--dumppath=<path>] [-h,--help] [-v,--version]
1010
1111
Required Arguments
1212
-----------------------------------
13-
<driver>
13+
<driver>
1414
Hardware driver to dynamically link (e.g. **riffa**,
1515
**ft600**, **test_driver**, etc.)
16-
[slot]
16+
[slot]
1717
Index specifying the physical slot occupied by hardware being controlled.
1818
If none is provided, the driver-defined default will be used.
1919

@@ -58,33 +58,33 @@ index 0) and a single headstage (starting at device index 256).
5858

5959
.. code-block:: console
6060
61-
$ ./liboni-test riffa 0
61+
$ ./liboni-test riffa 0
6262
63-
Jon Newman @ MIT **
64-
Jie Zhang @ MIT ////
65-
Aarón Cuevas López @ UPV ///.
66-
Josh Seigle @ Allen ///,.
67-
Jakob Voigts @ MIT *///,
68-
*. ///,,
69-
,####/ ///,,,
70-
,,,,/####// *///,,.
71-
,,,,, //##//// ///,,,
72-
,,,,, ,///#///// ///.,,,
73-
,,,,, //// ////// *///,,,,
74-
,,,,, ,//// /////, /// ,,,,
75-
,,,, //// ,/////./// ,,,
76-
.,,,, .//// ,///##// ,,,
77-
.,,,, //// */###/ .,,,
78-
,///***,,..........,,,... ,//// /##(///,,,
79-
.,,,,,,**,,..................,((((,..../(((((((((.
80-
.,......, .*(((/...,(((,,,(###
81-
......... //// ///. ///,
82-
........, ,///* */// ////
83-
Open Ephys Org. .,......, //// ///.///
84-
........, *///(/////
85-
Supporting open science .,......,//((((//
86-
since 2010. ....,/(##(/
87-
.,###.
63+
Jon Newman @ MIT **
64+
Jie Zhang @ MIT ////
65+
Aarón Cuevas López @ UPV ///.
66+
Josh Seigle @ Allen ///,.
67+
Jakob Voigts @ MIT *///,
68+
*. ///,,
69+
,####/ ///,,,
70+
,,,,/####// *///,,.
71+
,,,,, //##//// ///,,,
72+
,,,,, ,///#///// ///.,,,
73+
,,,,, //// ////// *///,,,,
74+
,,,,, ,//// /////, /// ,,,,
75+
,,,, //// ,/////./// ,,,
76+
.,,,, .//// ,///##// ,,,
77+
.,,,, //// */###/ .,,,
78+
,///***,,..........,,,... ,//// /##(///,,,
79+
.,,,,,,**,,..................,((((,..../(((((((((.
80+
.,......, .*(((/...,(((,,,(###
81+
......... //// ///. ///,
82+
........, ,///* */// ////
83+
Open Ephys Org. .,......, //// ///.///
84+
........, *///(/////
85+
Supporting open science .,......,//((((//
86+
since 2010. ....,/(##(/
87+
.,###.
8888
8989
   +--------------------+-------+-------+-------+-------+---------------------
9090
   |                    |       |Firm.  |Read   |Wrt.   |
@@ -150,4 +150,4 @@ index 0) and a single headstage (starting at device index 256).
150150
        a - reset the acquisition clock counter
151151
        x - issue a hardware reset
152152
        q - quit
153-
>>>
153+
>>>

0 commit comments

Comments
 (0)