Skip to content
This repository has been archived by the owner on Aug 21, 2023. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Adding documentation for requirements-dev.txt (#1332)
* Adding documentation for requirements-dev.txt

* Update README.md

* Update README.md

* Updated doc for requirements-dev.txt

* Update PR

* Update README.md as per Junye's suggestion

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>

* Fix indentation

Co-authored-by: Junye Huang <h.jun.ye@gmail.com>
Co-authored-by: Soolu Thomas <soolu.elto@gmail.com>
  • Loading branch information
3 people committed Jan 10, 2023
1 parent 3acc464 commit 0523acf
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.md
Expand Up @@ -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
Expand Down

0 comments on commit 0523acf

Please sign in to comment.