Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonvranek committed Mar 9, 2021
1 parent 0a851d3 commit 62f4ba6
Show file tree
Hide file tree
Showing 15 changed files with 6,281 additions and 34 deletions.
6 changes: 0 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@
- create virtualenv: ```python3 -m virtualenv --python=/usr/local/bin/python3 chisel_nb_env```
- activate it: ```source chisel_nb_env/bin/activate```
- install jupyterlab (which includes jupyter notebook): ```pip install jupyterlab```## Requirements (mac)
- setup some virtualenv (im using python3.8.2)
- ```pip install virtualenv```
- find your python3 binary: ```which python3``` which for me is ```/usr/local/bin/python3```
- create virtualenv: ```python3 -m virtualenv --python=/usr/local/bin/python3 chisel_nb_env```
- activate it: ```source chisel_nb_env/bin/activate```
- install jupyterlab (which includes jupyter notebook): ```pip install jupyterlab```

### Setup the Jupyter Scala kernel Almond (https://almond.sh)
- Borrowed from the Chisel-Bootcamp install guide: https://github.com/freechipsproject/chisel-bootcamp/blob/master/Install.md
Expand Down
2 changes: 1 addition & 1 deletion chisel_nbdev/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.1.2"
__version__ = "0.1.5"
24 changes: 24 additions & 0 deletions docs/_data/sidebars/home_sidebar.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,30 @@ entries:
- output: web,pdf
title: Overview
url: /
- output: web,pdf
title: 'Export to scala sbt project '
url: export_scala.html
- output: web,pdf
title: Synchronize and diff
url: sync_scala.html
- output: web,pdf
title: show_scaladoc
url: show_scaladoc.html
- output: web,pdf
title: Convert to html
url: export_scala2html.html
- output: web,pdf
title: Extract tests
url: test_scala.html
- output: web,pdf
title: Fix merge conflicts
url: merge.html
- output: web,pdf
title: Command line functions
url: cli.html
- output: web,pdf
title: Clean notebooks
url: clean_scala.html
- output: web,pdf
title: Creating a basic Chisel module to be imported by other files.
url: ToImport.html
Expand Down
463 changes: 463 additions & 0 deletions docs/clean_scala.html

Large diffs are not rendered by default.

Loading

0 comments on commit 62f4ba6

Please sign in to comment.