Skip to content

Commit 0827141

Browse files
Update documentation and add requirements for RTD
1 parent 6d4fae4 commit 0827141

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Bug Reports
2525
To report issues or suggest improvements, use the `GitHub issue tracker <https://github.com/brian-team/brian2wasm/issues>`_ or post in the `Brian Discourse Group <https://brian.discourse.group/>`_.
2626

2727
.. tip::
28-
Before submitting a bug report, check the `known issues <known_issues>`_ page to see if your issue is already documented.
28+
Before submitting a bug report, check the `known issues <user/issues.html>`_ page to see if your issue is already documented.
2929

3030
Contents
3131
--------

docs/user/html.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ After the simulation completes, variables from your ``Brian 2`` script are acces
6868
Variable Access Examples
6969
~~~~~~~~~~~~~~~~~~~~~~~
7070

71-
- For a spike monitor named ``spikemon``:
71+
- For a spike monitor named ``spikemonitor``:
7272

7373
.. code-block:: javascript
7474
@@ -78,7 +78,7 @@ Variable Access Examples
7878
// Access neuron indices
7979
var neuron_indices = brian_results['spikemonitor'].i;
8080
81-
- For a state monitor named ``statemon`` recording voltage:
81+
- For a state monitor named ``statemonitor`` recording voltage:
8282

8383
.. code-block:: javascript
8484

docs/user/issues.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Known Issues
44
Below is a list of known issues with ``brian2wasm``. For additional details or to report new issues, visit the `bug tracker on GitHub <https://github.com/brian-team/brian2wasm/issues>`_.
55

66
- **Automatic Device Setting**:
7-
Do not call ``set_device(...)`` in your ``Brian 2`` script, as ``brian2wasm`` automatically configures the device. Including this call may cause errors or unexpected behavior.
7+
When using the brian2wasm CLI tool, do not call ``set_device(...)`` in your Brian 2 script. The CLI automatically configures the device, and adding your own call may cause errors or unexpected behavior.
8+
9+
However, if you are not using the CLI (e.g. running a script directly in Python), you can still manually set the device to ``wasm_standalone`` with ``set_device("wasm_standalone")``.
810

911
- **Plotly CDN Dependency**:
1012
The generated HTML files rely on Plotly charts that load assets from a CDN (``https://cdn.plot.ly/plotly-latest.min.js``). An internet connection is required for these charts to render properly.

rtd-requirements.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
sphinx
22
sphinx_rtd_theme
33
sphinx-tabs
4-
sphinxcontrib-mermaid
4+
sphinxcontrib-mermaid
5+
numpy
6+
brian2

0 commit comments

Comments
 (0)