Skip to content

Commit

Permalink
Merge pull request #9 from SECQUOIA/adding_compile_to_readme
Browse files Browse the repository at this point in the history
Updated README to include instructions for local build
  • Loading branch information
bernalde authored Oct 8, 2024
2 parents bd60cc9 + 3d96fcc commit 3e83e99
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,13 @@
A conversion of the Pyomo workshop into a jupyter book

Find the companion website [here](https://secquoia.github.io/pyomo_jupyter_book/intro.html)


### How to build locally
Ensure you've opened the directory of the jupyter-book as the working directory. You should have a _config.yml and _toc.yml file in this directory. Make sure you're in a virtual environment. Install jupyter-book is using:
`pip install jupyter-book`
then
`jupyter-book build ./`
to build the current working directory into a jupyter-book.

The html is in the folder `_build\html\` and you can preview the book by opening the file `_build\html\index.html`

0 comments on commit 3e83e99

Please sign in to comment.