Skip to content

Commit

Permalink
add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
pauleve committed May 4, 2024
1 parent 021ae28 commit edb0750
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Source for BoNesis documentation

This is using https://jupyterbook.org.

- Setup: `pip install -r requirements.txt`
- Build: `make build` ; optionaly `make clean build` or `make depclean build` to clear cache
- Test: `make try`

Useful docs:
- [MyST Markdown syntax cheat sheet](https://jupyterbook.org/en/stable/reference/cheatsheet.html)
- [Content elements](https://jupyterbook.org/en/stable/content/index.html)
- [MyST reference](https://myst-parser.readthedocs.io/en/latest/)
- Converting notebook to MyST: `jupytext _notebooks/file.ipynb --to myst -o file.md`
- Converting MyST to notebook: `jupytext file.md -o _notebooks/file.ipynb`
2 changes: 1 addition & 1 deletion language.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Objects
</tr>
<tr><td>

`O = obs({a: 1, b: 1, ...})`{l=python}
`O = obs({a: 1, b: 0, ...})`{l=python}

</td><td>

Expand Down

0 comments on commit edb0750

Please sign in to comment.