An open API service indexing awesome lists of open source software.

https://github.com/najuzilu/jupyterbook_proof_example

Step-by-step example of how to utilize this extension in Jupyter Book
https://github.com/najuzilu/jupyterbook_proof_example

Last synced: 2 months ago
JSON representation

Step-by-step example of how to utilize this extension in Jupyter Book

Awesome Lists containing this project

README

        

# Utilizing Jupyter Book with sphinxcontrib-prettyproof

Below are some instructions on how to setup a Jupyter Book example and utilize the sphinxcontrib-prettyproof extension.

```bash
conda create -n myproofbook pip
conda activate myproofbook
pip install jupyter-book
pip install sphinxcontrib-prettyproof

jupyter-book create myproofbook
cd myproofbook
```

Add extension under `_config.yml`:

```yaml
sphinx:
extra_extensions:
- sphinxcontrib.prettyproof
```

Now introduce proof and theorem directives:

```{proof:proof}
This is a proof directive.
```

```{proof:theorem} Title of theorem
This is a theorem directive.
```

Next build the book:

```bash
jb clean .
jb build .
```