jupyter-book1.0.3
jupyter-book1.0.3
Published
Build a book with Jupyter Notebooks and Sphinx.
pip install jupyter-book
Package Downloads
Authors
Project URLs
Requires Python
>=3.9
Dependencies
- click
<9,>=7.1 - Jinja2
- jsonschema
<5 - linkify-it-py
<3,>=2 - myst-nb
<3,>=1 - myst-parser
<3,>=1 - pyyaml
- sphinx
<8,>=5 - sphinx-comments
- sphinx-copybutton
- sphinx-external-toc
<2,>=1.0.1 - sphinx-jupyterbook-latex
<2,>=1 - sphinx-design
<1,>=0.5 - sphinx-thebe
<1,>=0.3.1 - sphinx-book-theme
<2,>=1.1.0 - sphinx_togglebutton
- sphinxcontrib-bibtex
<3,>=2.5.0 - sphinx-multitoc-numbering
<1,>=0.1.3 - pre-commit
~=3.1; extra == "code-style" - pyppeteer
; extra == "pdfhtml" - altair
; extra == "sphinx" - bokeh
; extra == "sphinx" - folium
; extra == "sphinx" - ipywidgets
; extra == "sphinx" - jupytext
; extra == "sphinx" - matplotlib
; extra == "sphinx" - nbclient
; extra == "sphinx" - numpy
>=2; extra == "sphinx" - pandas
; extra == "sphinx" - plotly
; extra == "sphinx" - sphinx-click
; extra == "sphinx" - sphinx-examples
; extra == "sphinx" - sphinx_inline_tabs
; extra == "sphinx" - sphinx-proof
; extra == "sphinx" - sphinxext-rediraffe
~=0.2.3; extra == "sphinx" - sympy
; extra == "sphinx" - altair
; extra == "testing" - beautifulsoup4
; extra == "testing" - beautifulsoup4
; extra == "testing" - cookiecutter
; extra == "testing" - coverage
; extra == "testing" - jupytext
; extra == "testing" - pandas
; extra == "testing" - pyppeteer
; extra == "testing" - pytest
>=6.2.4; extra == "testing" - pytest-cov
; extra == "testing" - pytest-regressions
; extra == "testing" - pytest-timeout
; extra == "testing" - pytest-xdist
; extra == "testing" - sphinx_click
; extra == "testing" - sphinx_inline_tabs
; extra == "testing" - pydata-sphinx-theme
>=0.15.3; extra == "testing" - texsoup
; extra == "testing" - numpy
>=2; extra == "testing" - matplotlib
; extra == "testing"
Jupyter Book
Jupyter Book is an open-source tool for building publication-quality books and documents from computational material.
Jupyter Book allows users to
- write their content in markdown files or Jupyter notebooks,
- include computational elements (e.g., code cells) in either type,
- include rich syntax such as citations, cross-references, and numbered equations, and
- using a simple command, run the embedded code cells, cache the outputs and convert this content into:
- a web-based interactive book and
- a publication-quality PDF.
Governance of this project
Jupyter Book 1.x is now in a maintenance phase, where new feature requests have lower priority than bugfixes. Jupyter Book 2.x will be built on the new MyST-MD document engine. See our blog post for more information.
Contribute or improve the book
Notice some inefficient CSS? A typo in the text? Want to add a cool feature so that others can enjoy the improvements to Jupyter Books? Check out the Jupyter Book Contributor's Guide. We'd love your help!
Acknowledgements
Jupyter Book is maintained and primarily developed by the Executable Book Project.