mirrors/rocm_jax
1
0
Fork 0
mirror of https://github.com/ROCm/jax.git synced 2025-04-19 05:16:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

Developer docs: mention how to setup new notebooks for syncing

Browse Source
This commit is contained in:
Jake VanderPlas 2021-03-22 15:44:47 -07:00
parent a1cf06677d
commit 0572f364e7
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/developer.md
View File

@ -248,6 +248,18 @@ $ pre-commit run --all
See the pre-commit framework documentation for information on how to set your local git
environment to execute this automatically.
### Creating new notebooks
If you are adding a new notebook to the documentation and would like to use the `jupytext --sync`
command discussed here, you can set up your notebook for jupytext by using the following command:
```
$ jupytext --set-formats ipynb,md:myst path/to/the/notebook.ipynb
```
This works by adding a `"jupytext"` metadata field to the notebook file which specifies the
desired formats, and which the `jupytext --sync` command recognizes when invoked.
### Notebooks within the sphinx build
Some of the notebooks are built automatically as part of the Travis pre-submit checks and