Building the Documentation¶
To install (and activate) a conda environment named
containing all the necessary packages (except pandoc), use:
conda env create -f docs/environment.yml source activate ipywidget_docs # Linux and OS X activate ipywidget_docs # Windows
If you want to install the necessary packages with
pip instead, use
--user if working in a virtual environment):
pip install -r docs/requirements.txt --user
Once you have installed the required packages, you can build the docs with:
cd docs make clean make html
After that, the generated HTML files will be available at
build/html/index.html. You may view the docs in your browser.
You can automatically check if all hyperlinks are still valid::
Windows users can find
make.bat in the
You should also have a look at the Project Jupyter Documentation Guide.