Skip to content

Commit

Permalink
rm rust from master docs temporary
Browse files Browse the repository at this point in the history
Signed-off-by: Andrey Parfenov <[email protected]>
  • Loading branch information
Andrey1994 committed Nov 1, 2021
1 parent e5429d3 commit 99cc850
Show file tree
Hide file tree
Showing 4 changed files with 2 additions and 67 deletions.
6 changes: 0 additions & 6 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,12 +172,6 @@ jobs:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
VERSION: ${{ github.event.inputs.version }}
- name: Prepare Rust Package
run: |
cd $env:GITHUB_WORKSPACE\rust-package\brainflow
(gc .\Cargo.toml).replace('0.0.0', $env:VERSION) | Out-File -encoding ASCII Cargo.toml
env:
VERSION: ${{ github.event.inputs.version }}
# publish packages
- name: Publish Packages
if: github.event.inputs.publish == 'true'
Expand Down
15 changes: 0 additions & 15 deletions docs/BuildBrainFlow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,21 +86,6 @@ Steps to setup Matlab binding for BrainFlow:
- Add folders lib and inc to Matlab path
- If you want to run Matlab scripts from folders different than brainflow/matlab-package/brainflow you need to add it to your Matlab path too

Rust
----

You should build core module code first using instruction below after that build Rust package.

.. compound::

Commands to build Rust package ::

cd rust-package
cd brainflow
cargo build
# for developers, if you want to regenerate binding add --features="generate_binding"


Julia
--------

Expand Down
39 changes: 0 additions & 39 deletions docs/Examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -434,45 +434,6 @@ Julia EEG Metrics
.. literalinclude:: ../julia-package/brainflow/test/eeg_metrics.jl
:language: julia

Rust
--------

Rust Get Data from a Board
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../tests/rust/src/brainflow_get_data/main.rs
:language: rust

Rust Markers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../tests/rust/src/markers/main.rs
:language: rust

Rust Denoising
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../tests/rust/src/denoising/main.rs
:language: rust

Rust Downsampling
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../tests/rust/src/downsampling/main.rs
:language: rust

Rust Signal Filtering
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../tests/rust/src/signal_filtering/main.rs
:language: rust

Rust Transforms
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. literalinclude:: ../tests/rust/src/transforms/main.rs
:language: rust

Notebooks
------------
.. toctree::
Expand Down
9 changes: 2 additions & 7 deletions docs/UserAPI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -141,16 +141,11 @@ A few general rules to keep in mind:
Julia API Reference
---------------------

Julia binding calls C\C++ code as any other binding. Use Julia examples and API reference for other languaes as a starting point.
Julia binding calls C/C++ code as any other binding. Use Julia examples and API reference for other languaes as a starting point.

Since Julia is not Object-Oriented language, there is no DataFilter class. BoardShim class exists but all BoardShim class methods were moved to BrainFlow package and you need to pass BoardShim object to them.

Like here:
Example:

.. literalinclude:: ../julia-package/brainflow/test/serialization.jl
:language: julia

Rust API Reference
---------------------

Currently we don't have autogenerated API reference for Rust, please check API reference for other languages.

0 comments on commit 99cc850

Please sign in to comment.