+0
Daily
15,348
stars
4,566
forks
604
watchers
347
prs
427
issues
0
releases
README
Jupyter Read this in other languages: English, Español, Português, Français Jupyter metapackage for installation and documents Documentation structure This documentation uses the Sphinx documentation engine. The documentation is located in the docs/source folder. When you build the documentation, it will be placed in the docs/build folder. It is written in a combination of reStructuredText and MyST Markdown. Build the documentation locally There are a few ways to build the documentation; see below for instructions: Build the documentation automatically with nox The easiest way to build the documentation locally is by using the nox command line tool. This tool makes it easy to automate commands in a repository, and we have included a docs command to quickly install the dependencies and build the documentation. To build and preview the site locally, follow these steps: 1. Clone this repository. console $ git clone https://github.com/jupyter/jupyter $ cd jupyter 2. Install nox console $ pip install nox 3. Run the docs command console $ nox -s docs This will install the needed dependencies in a virtual environment using pip. It will then place the documentation in the docs/build/html folder. You may explore these HTML files in order to preview the site. Create a live server to automatically preview changes There is another nox command that will do the above, and also create a live server that watches your source files for changes, and auto-builds the website any time a change is made. To start this live server, use the following nox command: console $ nox -s docs-live When the build is finished, go to the URL that is displayed. It should show a live preview of your documentation. To stop serving the website, press Ctrl-C in your terminal Build the documentation manually To build the documentation manually, follow these steps: First, install the miniconda Python distribution. Next, navigate to the /docs directory and create a conda environment: bash conda env create -f environment.yml Activate the environment: bash source activate jupyter_docs Build the docs using Sphinx with the following commands: bash make clean make html The docs will be built in build/html. They can be viewed by opening build/html/index.html or starting an HTTP server and navigating to 0.0.0.0:8000 in your web browser. bash python3 -m http.server Releasing the jupyter metapackage Anyone with push access to this repo can make a release of the Jupyter metapackage (this happens very rarely). We use [tbump][] to publish releases. tbump updates version numbers and publishes the git tag of the version. Our GitHub Actions then build the releases and publish them to PyPI. The steps involved: 1. Install tbump: pip install tbump 2. Tag and publish the release tbump $NEW_VERSION. That's it! [tbump]: https://github.com/your-tools/tbump
Top issues
#430Translating Official Documentation to Spanish43 comments · 2019-06-23#264Resource Info Request26 comments · 2017-05-31#190How to cite Jupyter and its subprojects20 comments · 2016-08-08#511Anyone want to help with a round of documentation improvements?14 comments · 2020-06-05#216Review top-level docs for prospective kernel authors13 comments · 2016-10-30#572Download PDF - nbconvert failed: Unsupported platform: freebsd1210 comments · 2021-10-22#333Inconsistencies, rolling back edits, and keeping track of the document's global state10 comments · 2018-04-12#220Glossary in docs8 comments · 2016-11-10