Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

Jupyter Book #161

Merged
merged 10 commits into from
Oct 26, 2023
Merged

Jupyter Book #161

merged 10 commits into from
Oct 26, 2023

Conversation

qwang98
Copy link
Collaborator

@qwang98 qwang98 commented Oct 25, 2023

Ready for review. @leolara

To run this:

pip install jupyter-book
jupyter-book build book # book is the sub-directory where all the book stuffs live in

A _build folder with html artifacts should be created. Terminal should print out directions on how to open the build files in the browser. For example, pasting a local directory like file:///Users/steve/Documents/repo/chiquito-6_2_23_v10/chiquito/book/_build/html/index.html into the browser bar.

Once we are good with the content and merge. I shall create a follow up PR that add CI to auto builder and host the book via gh-pages, though it could take quite some tweaking as our gh-pages branch currently builds and hosts the Rust doc.

CI will follow something like the following: https://jupyterbook.org/en/stable/start/publish.html

@qwang98 qwang98 requested a review from leolara October 25, 2023 20:52
@qwang98 qwang98 self-assigned this Oct 25, 2023
@qwang98 qwang98 linked an issue Oct 25, 2023 that may be closed by this pull request
@qwang98 qwang98 marked this pull request as ready for review October 25, 2023 21:45
@leolara leolara added this pull request to the merge queue Oct 26, 2023
Merged via the queue into main with commit d0933d7 Oct 26, 2023
4 checks passed
@alxkzmn alxkzmn deleted the steve/jupyter-book branch August 7, 2024 11:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Create online book for Chiquito
2 participants