From a52b583d657ca99553891f14eb2254a4c4c050a0 Mon Sep 17 00:00:00 2001 From: glopesdev Date: Fri, 24 May 2024 06:03:28 +0100 Subject: [PATCH] Add docfx docs infrastructure --- .config/dotnet-tools.json | 12 ++ .gitattributes | 2 + .gitignore | 10 + .gitmodules | 6 + LICENSE | 427 ++++++++++++++++++++++++++++++++++++++ api/.gitignore | 5 + articles/introduction.md | 1 + articles/toc.yml | 2 + docfx-tools | 1 + docfx.json | 76 +++++++ favicon.png | Bin 0 -> 10746 bytes filter.yml | 4 + index.md | 5 + logo.svg | 264 +++++++++++++++++++++++ src/onix-refactor | 1 + toc.yml | 4 + workflows/.gitignore | 2 + 17 files changed, 822 insertions(+) create mode 100644 .config/dotnet-tools.json create mode 100644 .gitattributes create mode 100644 .gitignore create mode 100644 .gitmodules create mode 100644 LICENSE create mode 100644 api/.gitignore create mode 100644 articles/introduction.md create mode 100644 articles/toc.yml create mode 160000 docfx-tools create mode 100644 docfx.json create mode 100644 favicon.png create mode 100644 filter.yml create mode 100644 index.md create mode 100644 logo.svg create mode 160000 src/onix-refactor create mode 100644 toc.yml create mode 100644 workflows/.gitignore diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json new file mode 100644 index 00000000..278b6c75 --- /dev/null +++ b/.config/dotnet-tools.json @@ -0,0 +1,12 @@ +{ + "version": 1, + "isRoot": true, + "tools": { + "docfx": { + "version": "2.75.3", + "commands": [ + "docfx" + ] + } + } +} \ No newline at end of file diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 00000000..c5cc0eee --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +* text=auto +*.ico binary diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..8bdcda84 --- /dev/null +++ b/.gitignore @@ -0,0 +1,10 @@ +############### +# folder # +############### +/**/DROP/ +/**/TEMP/ +/**/packages/ +/**/bin/ +/**/obj/ +_exported_templates +_site diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 00000000..8e2794d8 --- /dev/null +++ b/.gitmodules @@ -0,0 +1,6 @@ +[submodule "docfx-tools"] + path = docfx-tools + url = https://github.com/bonsai-rx/docfx-tools +[submodule "src/onix-refactor"] + path = src/onix-refactor + url = https://github.com/neurogears/onix-refactor.git diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..53d7025a --- /dev/null +++ b/LICENSE @@ -0,0 +1,427 @@ +Attribution-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-ShareAlike 4.0 International Public +License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-ShareAlike 4.0 International Public License ("Public +License"). To the extent this Public License may be interpreted as a +contract, You are granted the Licensed Rights in consideration of Your +acceptance of these terms and conditions, and the Licensor grants You +such rights in consideration of benefits the Licensor receives from +making the Licensed Material available under these terms and +conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + l. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + m. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + + including for purposes of Section 3(b); and + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public licenses. +Notwithstanding, Creative Commons may elect to apply one of its public +licenses to material it publishes and in those instances will be +considered the “Licensor.” The text of the Creative Commons public +licenses is dedicated to the public domain under the CC0 Public Domain +Dedication. Except for the limited purpose of indicating that material +is shared under a Creative Commons public license or as otherwise +permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the public +licenses. + +Creative Commons may be contacted at creativecommons.org. \ No newline at end of file diff --git a/api/.gitignore b/api/.gitignore new file mode 100644 index 00000000..e8079a3b --- /dev/null +++ b/api/.gitignore @@ -0,0 +1,5 @@ +############### +# temp file # +############### +*.yml +.manifest diff --git a/articles/introduction.md b/articles/introduction.md new file mode 100644 index 00000000..f6ecaa67 --- /dev/null +++ b/articles/introduction.md @@ -0,0 +1 @@ +# Introduction \ No newline at end of file diff --git a/articles/toc.yml b/articles/toc.yml new file mode 100644 index 00000000..32b667c4 --- /dev/null +++ b/articles/toc.yml @@ -0,0 +1,2 @@ +- href: ../index.md +- href: introduction.md \ No newline at end of file diff --git a/docfx-tools b/docfx-tools new file mode 160000 index 00000000..dc5044a0 --- /dev/null +++ b/docfx-tools @@ -0,0 +1 @@ +Subproject commit dc5044a069d27e6c6db6194d79a8e6b0bec84ccd diff --git a/docfx.json b/docfx.json new file mode 100644 index 00000000..2766806f --- /dev/null +++ b/docfx.json @@ -0,0 +1,76 @@ +{ + "metadata": [ + { + "src": [ + { + "files": [ + "src/**.csproj" + ] + } + ], + "dest": "api", + "filter": "filter.yml" + } + ], + "build": { + "content": [ + { + "files": [ + "**/*.{md,yml}" + ], + "exclude": [ + "_site/**", + "docfx-tools/**", + "filter.yml" + ] + } + ], + "resource": [ + { + "files": [ + "logo.svg", + "favicon.png", + "images/**", + "workflows/**" + ] + } + ], + "output": "_site", + "overwrite": [ + { + "files": [ + "apidoc/**.md" + ], + "exclude": [ + "obj/**", + "_site/**" + ] + } + ], + "template": [ + "default", + "modern", + "docfx-tools/template", + "template" + ], + "globalMetadata": { + "_enableNewTab": true, + "_enableSearch": true, + "pdf": false, + "_appFooter": "© 2024 Open Ephys and Contributors. Made with docfx", + "_appFaviconPath": "favicon.png" + }, + "markdownEngineName": "markdig", + "markdownEngineProperties": { + "markdigExtensions": [ + "attributes", + "customcontainers" + ] + }, + "xref": [ + "https://bonsai-rx.org/docs/xrefmap.yml", + "https://horizongir.github.io/opencv.net/xrefmap.yml", + "https://horizongir.github.io/reactive/xrefmap.yml" + ] + } +} \ No newline at end of file diff --git a/favicon.png b/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..57804796bcc133903e9e844180653a1e5c3d8774 GIT binary patch literal 10746 zcmV5#gd6{p$L6%8VYKogto!EG zk~lo5e1uJVI;PD*U}Sptfy)rS#3Mfd^9EE- zX3WQ=a#4f2i;&XqLg@QB#J*nwl3>uh#!ZtKf$QGP_5Fr$ zdi}exUbo00(TwO#p9kj;>YK=}qlIA zYevMSujY}efLLGkB8O|dHie8Vp(I?VXGd{zT;LQaQa$+={NnA2Y?klM41~4o!^3#-)T$h#Z**yW~YGv z+FUu2s0si*g=vlB5IpBPc$c1F1=7r2L&`%Uzl-kgLmYap>VQnd>CBbOS-B zGV-(8k0(0j7ltA9{~kieR{D`4 zJ*bEoh(mve(EBq;sn@Ggycm78qzK;gP62=Ft$%6Q zJ*#>%9!VIVdMl5ASmaGt?ub>(q3J;-e)m)MH`j?-S+o$le*~%64M>%-&z1v%*1!MX zE&&g1EL2nx9KH7{1N3fr-gEG=2(7tE>phr1PRu~cZb6a4pHgoa{(xcr0m`qiGb`cz zS8_<(K-3u7ZIuCfH<1HpTn2hnv16068zFRlS62KWX6(2{-Fu?wlP_;6;Cnl4gyw2> zA7ySY!fS7XYvB^z7o&WF^41d zMdFC8`wSc{GnL~}RnPL^9W$MfggEdg2)#drl-UHB9tx`JFd8~ftsIgfc*om${IS=5 z`hbl9tsF#-)>(+&@L3S2u5^>Kn^1iJzaVAaG1v^J-r`^tEq>o4;I6j|_WNvIZPjVE z^BjB(LThfe>i#BJN0K?Q(Dw_7y+1P;$Q3-6f~9-%5^i`ak9R8QuThFY9T9aH;A#O2 zECWKvS0|u@=UfZ#5hp7kzX@H0B!sT-LhPsTCvxkw-_NcIr`|Os!?Qb!vh%(zL}%s# z!Y6};jsYBX@{6&JL=J`5z&OYcDzSQn0}SdWq~+H=Vds;wIc{%kLq!P}zLJ-{>MGip z8}Q5ni(d%1TE}d~Mu1i(L-X+l#P9hgz*&`0MuM1pS);cBQxCt?-uZ@ z?n;{JSP97C6@YgU!0o9+*$B|euEM))C4y&PqpY*8UJ@h{FLpc$vG0F%%~T76DFWrD z|Kv^Z*HEJTGJrXN=-FW56H5O+Nvk?Q)9WC;5}Miyy%73;2eI$xARmmqy^*|p$A&!q z+^1GwPy*I6)aCp@@CdNra#{H+*QyH8WTuOL^0RQ57U3;H9C}{n%2K|4ud-fD1(fIe zOWfIt+;qG5!2sVPu-FBFvvEqUJbLdo2K1gXHQApd>+S;=j+gsT)&0FxD4F59e+Y5# zk0v+}8NjL3oyf4>eR&BNzm`XrRf-^q6V4W}&{5#m0c%^BnZl9bS98p%LC> zdZVXmY3R9KS%_58uckZGi{Mwc74USsMT#Kv0I}6z{zCwVHl|fofc7mvs}$jFL=%SP z7{20;uK>jXBWA3*Imlmw9#OVuO*Ye!wZgX;EPe^Vhjh_#6rh!v&2+7%bFd)_p;Rb^ zKlS{0SNM~?vUTbtkzvCL4G(WD;HRA?a%U1RydMDz9S?XH0Q69zvsD#`j^F!D@O4ev zk6au=VcP?clK(Wx8?Jg~ z%|-lRr$LIcqYfNfGPb$b(8r=xUq~2pkR;zi5INK65{Eg8{9J43iG_9CiXi=UxkN6KKPf)qaq| zpMGva)QCCfvE!@+;s-Yt@SAQONy^Es)4v2PbR6KGZMt|d5gqLhXvPpY?NZRA%J@c( zL&f(WhLnEmLxoT0SMpX;#O1H+@Yir8z!F!=?w#7qaK>snNvb@N^D+gl3cz_ z?E3|To}cWs{>eJ=J7##YD9NIR`ZTz#i#Y$4JftbX%mB^}7Cse-oT}K-zEVfCAE3no#9SZ5Y!~3jqwWUs!m1Q` z?69se+W+{I3=0x&+fb&cJh^p}JvnqN;F@j+VwBy(1c0ubh#?h{5Qeuv60)*2!`bFX zd%mXfBTfR;$SNbi7{ z?+3(j3LgW4r%i)rLD*7)>+`F7$YE$*Xy!1s+IT1{R<+0mg+t zDc^~CJxvF+B<3Jxdm)e+ZoHg4#ku@PHNtmT!n~93WiwMP!Rt5p@QQe7>2bsnt4Ru& z3TQFg4I#4w5J=%urwxbCodMU3Kur?e`a^MeCbTND>^y8lW69xfVDniWmKuB*l#L?crtRB9@8%!mDxsw|YP{sS@{ouk!!qKu`_D}B3 z2{_}g?MM~%##Jfaf#n^Y9K$ycX~KNnB8MbG%=baebjf0dS~+>blk*JGHM8Jo+}rKX zDsjPF;6jIkt6K@q{}DOKVOEfE%PU=YuG_Aqm{p!}g6_mRE}a#@RkNeA%a3-YP|Ty4 z+ytpGYz&ZhZI%l;5xH;{`0$7JXT{g;2*c6#X>h@V$C%;%)Ro5VuXf46uGKax;Kb91 zw!q7m%)6=qEz8N-?vgj0WPIK;C&|xeP6Kn-mVML=KrvSnxabMs605-Yu@<4cDB+VY zb>bhrwOPrQ=t-i+E%W0zy)F2GL#A>-O9F&!rz~DTEEvj_M_;yQQ53-wTRwbHnd%E5 z@glwwd}1}2vwp(Ik)O6F@xYtC5TOP z<8Sxj2U~}#;aHmYc=ogqZdwrEFKg&?LEwDh(b7K7U{XW(W7oq%{W61Z0WKa9J|LS#Rob z%?u!Xj!_RPl_$I|X2AKtMUDa=KNZY3Z&LAM^crN$`1C8C_(P}lcc<&DDhIEf8Nrpa zqZ9hAeE?`#ycm8DQjxUc%9wcq$2GxwFqOF7yBj@MJKAmm^X{w4@8Z`xhH>ZX-3lVO ztCzlw9tVDO1exh3c8g#gmme;DV1}#YIXQ;dy1C#(WPh%5?y8B749qhFT?EUTYf$71d0G?3T58rqrCmyfv-yJF7X8R5-&!PlPy zE_x!Ei)xsw_W}RzmO*^}?S2$%%1k$wu@R6T_(%f2QD(aFU}Wv9qZN=Z_Kb#c%?={G zYPy!YH01-cWKzy6KU4E9>%iRF(*z6_1f2J`9q7oaOy_0EA&pstXG~TE53QTpC89!r z9(PCv_>XLW?=a#{dqZR30tbMr`#8AZ5?x6SNfEsJwQl@sr}=LLmAsi%Z9&|+u&(TH zmq~yg;lRq`5}AV`xUvoInvd|NEJPkSnyvsxazSVu!8J?u&?Ek>g~p%-rRRuq&Y;`D@(vY8U=k z!)7}2*SKy@6z5G>md?T!faW7EMAzCKhLH!J&hvw8FE0)GP{FKd&PMzTskU zk)uJOP)0Wrm%sE*AD(`1(CDdcHQ&mXKq;(B#jYw3Xa>ZtoC`jxzs|FYbDPtZ_kjx? z0ls-1n8WxgsUw@-G@O?oQOK*VR$HB$m(6tZLh2rvDh_Bq?ndnLDt}Os!=F9|E`AEQ z02P-s_v8G`8$BR@=L$R^SoZy#vrh=u&yC4W{Ayao0ZpO?i5wF*YZMPP1lyx8nc=40 z0WP!@VCJV?c)2f&PrR^G*Ou)*m>l+heqip+MgF>QRB_QoWiL_7(x{=hFvFeaSV4Xti#DI+L8<@ z0JK8dY3N3AgW+?gSC>OSbApR52j6hfq~T8*NTFy5i5U;Q)eCasudb&2gQBPHM;F&m z>8~->*((ZYQUt?iPX{?B*}hSo5zowB;ZKKHB3_K9$#7A`#n11+dntwVhXH&@8D$OZMf~`4|LMi|w+_{` zB6xIzPj(L_u|sRCD4@Lu#1NneZ@V@=2rjw;j+SdQxpW$Jtk(x}xa@_UD4HT_X#2>G zI@`!R^b+{9BU|B{#BqP}^~UOW6$Nzg)HZnbGtXYDndlV$M9BmAv0Uf_)9w<|iof>mBf}eIfI3H!TuYB6sHwJRD znT{NhtZCMB>=v&BUpu4;6#S~URSeJsQn`zJGJ!gA}yWZ))#{M4p? zJn^o!9NS7in)3b3<=AAVd;FsfWnKi8zlBr`(4kfPz&*!$i@^sMD2G2S1mAd>;xqx} zFW<#WkDU>I?QzADQ5tnmH!-!EbeIbB67|Q5U{Ol4B&lo zIxUK@uCx#MROcq{y!yHA6>{9S=0=>1;YUZbqSdEg5gff^0|2d_0Pckm1W#@S#S&W5 zWP9>*@bQ)MYoDFLoGgg=)W19NQXkbjugylGfj7*HgFNbtZq@^uBD|?&+o9H!Y~uop zz&Ec4B|F@0hExBmQX;(8amuglmpg_*?xEJ1>6GuysGf@=9(?hj22i0Nqnq`B<`_a} zw81^sL=QE_m$DGW&j24=VR-nH(U&kXA3dU6`QlEzHlWm-&a9o7H!t}&-?LvGPH5KV zO;>Jb)&rVnh+j3=yayG|55DmdInkkPhO46X^^F5~a$|o@`)eE+^WgIbHhxe-!r1GP zU^$?*;m`C2~ zmBXrPwUK4+(wU`dReD=7Q$ThwjZ{|>`QaRL$t()#9K@oi6wrFNuzP&uqM2~EP861| zVGZU1-*yxD$T7Bg;nQ#m{AVbK%U|d~x`t~BlE20m4r&DD*-+giKqwT^zoiGs_5q}O zCr^83smNhe$z$fMll?BZx-+UyP9A@mRC4Y5mpkxcZ|$1t$T+)xZVVUBC~pXmLtQ3MJC zxS#ph~1h2+9eAON%yd#N4=GdnBPP?3hBFXTlbadI zHT06!FpiD;RAmk|;$AERbmW4Wa84Wdpu)Mq$ImEbwRhIlG*=$Ete>?fasQh=_ErQX z2~s8pp*IO}aJU5Kq5#kz1#OnsiM#fVPg+Y*!4#UiSORED`4wM3f4BcL6=CW$C~M-Yv7Jd5v%^%ZZA=Tz*`U?%fYD(#Gwp?z9Ar|EijjC&9}{pW4^x{dL2b3Rfvq4dLNrE_(F8v`3L^dx2m_V(!os{t7 z;+FC+f_m4PY`i5L+JAHte232fpI8OH{vwTLIO80o%p&Gg^S+zRW8I4#=rh6gI^}st zQ6p2DAd~>yH2`5SrC5AWL#uihk6UNP(JF`5Srm;lZiD6nns*_3#bxj=xd6;Jw_*oX zb1_EurCNfwywYh|wW^Z%kcE`aLLAP@@-Y1qWFI!Mo!Jn?s>T4QNT#t(IWsdA(2V!O zHRCWu*FO%vezK(I#va{{v;D3kC6`|_Gx-t8!9vdf#NMQAg^(XIh&wBA=rMw3#GOAk zuinrIZY}#V1<;IYjd&B_JP9~w?uYOdcY_O9C08l`nzay2?U=4?5m*1K1Dl7nDOr20 zM;IjzOs2F{4k9UXgDIH{oBG8}ad1)uub&>pfuWMWMkSlEfF^G^Uo$v&9BfxQE%!l3 zA-v`$fU_cHfxW;?7puOg{KSqz^mrlkCm{}`N=h7o+5jca2=FZldvM)8(Ta0tI*T!Y zrl3@35WK$)Bxa0mfmK()ck~%X(5>p`7%Yf5_ix+LsivqrnbFA6p8!h^JUxRY4oo1n zVWZ5Ux6g`UVZgZTM|zH_8_)z~&f5si8J^I35xM?RxMqJu&mOCCY*CVM*K6JQ&6qT} zlelS$qU`@5o6rcn^2=OKwh!CAEsy(gX=}&?MR2l{PyH*b9ng%IIWp&|pOogz=|fLeCJy-XXvuZ!{yRlyLF*@`45f7&h}m$x+r&bkV|qfXPhx2hdSZlRz0#}4F4iR&Gb zA2i4Y{DCR0YEQO%<4tad>`fOmA^VXY@+bf_19OlWt`VG@>Is$yvb-VQf%u(Y1)pfv zvp@TfCD9>YL_VFDLyNX=AHcfj-a}{KaK+4MW)qFP>28=|4>R5Pv$FQp5ouD8a!&Bx z7BF`dj8hkWPC$;`@dK_cMQF^JooD(92>|h3&ehTc&$@wBC zYjjOdZX3WK`_jg2V#<{iihU;RWM#sS^O{2-rO=LTH=vmVd~gOhm&&N@iB82k5W46_ zcn&(sj%S{5PZVBHxzUE+@5A8xeIQV)NtW@(a1Qrv?5&#fYS}0i#C&2wgY6W-(Pv@X z&ux^LyRKx0NSo;-vU!K?R);IPQpmtd{)nKh1eTyd1dc#1AC?k9u=La4juta7N#R@D2T{~NmENtGHhyu?jT>gf;4!csiW!?_ zo$FQ@ehu!$OA-FWoo4J;(VS#PE9MHw59eh$n1Gz=O)1Karf7jtoic)mJKycWHZ}el zY8R<+f8x&MO-D{hc5kKt+Uf@tvP6*8A=Nn~iw`7DkQt5At}03Jr{|KMY9GXJdTO_9 zG12B@5f852Cn}2_c5lW5n&VOT=nueoO?na~Gnznu1mu%BS%esD-(^O#$eDfQQa23e zaQDVuHM*nS@vz7K0uByem|u^8>Z0*pC8t;=D})_eN)U1H#$Ig67-6Oxe?oh3 zbCQ;?oEE{+F}ia=*^aqX7LKFoQ$&^Nxi0&kk9fPtg zTn*qIPq_AM0gr6%LuU>9Ymg#H{u;AO!`=Q5^o8LA!zlPpD>K*T7z+?03(cm`54MOjJ)Q;B# zXfiYu3Ldi(w~vtLn)fORvV=v`1H(}j8xZa{d|?MCj+Hgjb~3HNU7!6rkz>1=bXF&iOy znW9jZM(yKJriD@;0Ghx`VnZ@jKt36a)ArM|7h8_qmM!4M4c)ff zn^BvhqVf;VNuaT!il8yff&FF0p}K`a=JFwQ>L)>BN9{BTIT84J`yl>odRSHEs75b> zA8!ca>?UigRhe~SLjcXkS`b`uB{-i|8Ai<_$JlwdW(u;eGs)1k+Q?tywplUMyQ0kmuSV)&1|(8dwo>fuPl8x_RZ_{>+WHEbNi46UuR=vLGw*)Qh5$OU`fhN+xRv)|>RLbCnZ&bQ$x0=} zH}z~IlOG=S;>xy2RX?JPoQ3fmeDMJM^+D(cG%13SbM6DGAl^&~QU(eFuHVp&w8oSM zO4g`!A4(GQ!0bBA@M+C{q~`?sI5>fq<2g7y4)|gL1lywUCxY_-qoy0sp8b!3@8Hw* zoX|F7$(r%m_xkW!GH07TnXwTnD1T;Suxb=RhsOzT)DL&q15eZkm)`?V*aOCuKs>tX z26XVmtKn>>a&6V$o*&5IOIrs}Fx6i}ABWOQ<$b&kJUpi!6fbD!=JdJ{Zi^z+7K1zF z0dZ!gKnh@gS@E&SvyYZJF?0K6al^g|8I@ldacAio z&3QuzopvKQf5hrN8@3+#9DQy}A6^{H8aAgLCn7T)dDI#8!cAs0SHKN#%nx_S3va{+ zSI`5_1_gvP1DcOEA$-OyRhglG1ayDyPva|F2Q>I=*b%l9@2SqkIioGDq%qM-6L zxFkaGZimc)oqjj`i2%H@0Ng=($gmlDCqSQOK$E%7(KxGW0sXVCVSI1rkWMpQWgkh( z5&vTmFRq>zDIZqF08hjxTOUXUcDNlNv4WI1C65{9_F?7UYXUSWgpuoo56M$R+gF88Pf199!*ogaZ>;=^-Q76oJ1XXqp+#h_k4fLldB#t@9CF zag~~NY}1!a&0pNwkG~I)na=({p;`&IqRx*?TEem-$T@h~55iv;fIH-q|J~(t%c6yO ztunt}ngH!tv>d*JPBD)bCeHk?!K`fAsNpvhBs>m$abY7O&0z$aBM7&}s!nv!3IX+i z<{b!<{kd(S)-@|Oj{G(LdrLoF9;z`jor4GG_khs@M$m^F4r;;K^Xn^S3pVzG)p2^& zfaZK51dqQGe7x1zeOoZwi-Q?Fwxz!&xHEG*!9@b#5@B#Y58&WrcgoozH=aDW2@&U> zu9X&$xZ+Ew1~eaULGbviK)|l1)?W~C`@22pslqh4j3TmKPB4!PT-XOLX?x6xW zIEF_SCva4~(Yfi=amh;JLN%aW(-$Fd%%xT3kVG$n-`O!#Jw@f|Ioaz17Y%|7dck?! zB|wue#1uZkr?v!e=Y9#pUIZ%%Os#9H2DJCUmGCY;Uh8@l8AtvakG|JuPct0>l$_Uj z9?b6s7Y%@~i-0*D6BuF0Dl@T1V8YGgO9wS#-{6QBTlH{NBSE1W(4kX42}k`5BllqX zTwmEXAZI_ajdLi+zy*C^J~z047tHIH|6K;L#&*HWBG1&@F^ z&GBW`a)5GUs9M!Mb|@;(ao{3;@C{LL;Q*L}#D{XbSN8W*LgE)kwjo%vilFje8&!ZN zQ(f@*E0j^$2E7IfA|BY>gRL2(@@tIn_%cW&Ga7MSuM5oYk-0D_a%Kp(6jpW5{&iT< zR6Vr>^+985aH|5e@6c87ELf&*KNgO*GOUU?u53aJ`@sc#B{Q1Lg$-iElhAEhy$=sB zs)t*rH=ViHqMXC(-G_2Ob3A1Exo(=?H7yxWc{Of(rw2P!XFn=Ke1;NGosN#Zed$(2~Lh+;tV;d%s5x~^*M&tHFk5Wnp;uBg1Mz>)no zmlX*vg<3I)eC_;KH&M0syIOQ2+rMHB7H$uD#^Y?R9D>N!zdG-G_wt97!f4ap*J zNg<#ad`r)UXWn6UJ;w+8A~W3soBGOUKO$RjEC@at0v8)Gqmh7Yt`cVi0cQrB_{x$d z&|}JnZ7ccuF4wuH{ZQ~ z0xO&M7Bii?3sMAV=JFzP-u+;FC9+j2I}rWY{&43Ip6MJe4RG?{$r~*el3go7pr)6& sDu|1l>cod9eE94E^?Ut`;AAxV{|7hT+sNx<5dZ)H07*qoM6N<$f;GLqTL1t6 literal 0 HcmV?d00001 diff --git a/filter.yml b/filter.yml new file mode 100644 index 00000000..3d3d6c9b --- /dev/null +++ b/filter.yml @@ -0,0 +1,4 @@ +apiRules: +- exclude: + hasAttribute: + uid: System.ObsoleteAttribute \ No newline at end of file diff --git a/index.md b/index.md new file mode 100644 index 00000000..8615d35b --- /dev/null +++ b/index.md @@ -0,0 +1,5 @@ +# Getting Started + +`OpenEphys.Onix` is a [Bonsai](https://bonsai-rx.org/) interface for [Open Neuro Interface](https://github.com/open-ephys/ONI)-compliant hardware. All device initialization, configuration, and streaming functionality is exposed via reactive operators. + +To install `OpenEphys.Onix` use the Bonsai package manager and search for the **OpenEphys.Onix** package. \ No newline at end of file diff --git a/logo.svg b/logo.svg new file mode 100644 index 00000000..cbbe47b5 --- /dev/null +++ b/logo.svg @@ -0,0 +1,264 @@ + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/onix-refactor b/src/onix-refactor new file mode 160000 index 00000000..dcb94f63 --- /dev/null +++ b/src/onix-refactor @@ -0,0 +1 @@ +Subproject commit dcb94f6360e0e9cdb6dfe84cff701a1818991165 diff --git a/toc.yml b/toc.yml new file mode 100644 index 00000000..75764788 --- /dev/null +++ b/toc.yml @@ -0,0 +1,4 @@ +- name: Software Guide + href: articles/ +- name: Technical Reference + href: api/ \ No newline at end of file diff --git a/workflows/.gitignore b/workflows/.gitignore new file mode 100644 index 00000000..af455cba --- /dev/null +++ b/workflows/.gitignore @@ -0,0 +1,2 @@ +*.layout +*.svg \ No newline at end of file