diff --git a/README.md b/README.md index d6c1ff9a5..2a4c396c3 100644 --- a/README.md +++ b/README.md @@ -59,10 +59,26 @@ To add a gallery image to a notebook, select a cell with an output image and add In addition to serving up standalone notebooks, this repository also includes the infrastructure needed to build the tutorials into HTML documentation using [Sphinx](https://www.sphinx-doc.org/). Along with the Qiskit dependencies, building the documentation requires the following: +1. Fork and clone the forked repository. +2. Create a new virtual environment and install pip: ```bash -pip install Sphinx -pip install sphinx-rtd-theme -pip install nbsphinx +conda create -n qiskit-tutorials-dev pip +``` +3. Activate virtual environment: +```bash +conda activate qiskit-tutorials-dev +``` +4. Install python dependencies in your new virtual environment: +```bash +pip install -r requirements-dev.txt +``` +5. Install non-python dependencies: +```bash +conda install pandoc graphviz +``` +6. Create a local build: +```bash +sphinx-build -b html . _build ``` ## Authors and Citation