Skip to content

Commit

Permalink
added auto gen documentation and tutorials (#27)
Browse files Browse the repository at this point in the history
* added auto gen documentation and tutorials

* link fixed

* auto doc for lava-optim

* Update README.md

* added figure for learning tutorial

* minor corrections in svg

* restructured getting startet page and solved some issues

* minor fixes

* minor fixes

* rm table of content in dev guide
  • Loading branch information
weidel-p authored Sep 21, 2022
1 parent e327634 commit 9917a3e
Show file tree
Hide file tree
Showing 63 changed files with 3,234 additions and 510 deletions.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,26 @@ They will be in `_build/html`
```bash
make html
```



If new files have been created in the source code repositories (such as lava, lava-on-loihi, lava-optimization), sphinx-apidoc must be re-run.


```bash
sphinx-apidoc -o <output_path> <path-to-src-repo>/src/lava -t _templates -d 10 --implicit-namespace
```

Afterwards, the html files must be built:

```bash
make clean
make html
```



## Syncing Notebooks to the build
You can either manually create entry for IPython notebooks or add it to
`tutorial_list` entry. Once notebook is in the list, it will sync the notebook
with the main repo and include it in the build.
with the main repo and include it in the build.
Loading

0 comments on commit 9917a3e

Please sign in to comment.