Skip to content

Create a user documentation using Sphinx#24

Merged
mstimberg merged 27 commits intobrian-team:mainfrom
PalashChitnavis:sphinx
Sep 5, 2025
Merged

Create a user documentation using Sphinx#24
mstimberg merged 27 commits intobrian-team:mainfrom
PalashChitnavis:sphinx

Conversation

@PalashChitnavis
Copy link
Contributor

@PalashChitnavis PalashChitnavis commented Aug 10, 2025

@PalashChitnavis
Copy link
Contributor Author

TODO
user guide ::
Using brian2wasm cli tool all flags
How to setup html file for brian2wasm
How to run brian2wasm without cli set_device

developer guide::
Explaining how brian2wasm works

explain some examples along with html

Copy link
Member

@mstimberg mstimberg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice and very complete 👍 I only had a cursory look at the developer documentation, but the text and the diagrams look very helpful. I noticed a few minor issues in the user docs, and one major issue (the reference doc does not appear on readthedocs). But from my side this is almost good to merge, good work!

@mstimberg mstimberg merged commit c32f8e1 into brian-team:main Sep 5, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a user documentation

2 participants