Skip to content

Commit

Permalink
Readme.md file for doc folder.
Browse files Browse the repository at this point in the history
  • Loading branch information
lumip committed Apr 15, 2016
1 parent 890088a commit cf3f34e
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions doc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# qc-toolkit: Quantum Computing Toolkit - Documentation

This folder contains texts, configuration and scripts which are used to compile the documentation using [sphinx](http://www.sphinx-doc.org/en/stable/). It also contains usage examples for the qctoolkit.
You may either build the documentation yourself or read it on [readthedocs](http://qc-toolkit.readthedocs.org/).[![Documentation Status](https://readthedocs.org/projects/qc-toolkit/badge/?version=latest)](http://qc-toolkit.readthedocs.org/en/latest/?badge=latest)


## Examples
In the subdirectory *examples* you can find various [Jupyter notebook](http://jupyter.org/) files providing some step-by-step examples of how the qctoolkit can be used. These can be explored in an interactive fashion by running the *Jupyter notebook* application inside the folder. However, a static version will also be included in the documentation created with *sphinx*.

## Building the Documentation
To build the documentation, you will need [sphinx](http://www.sphinx-doc.org/en/stable/) and [nbsphinx](https://nbsphinx.readthedocs.org/) which, in turn, requires [pandoc](http://pandoc.org/). If the last two are not present, the examples won't be included in the documentation.
Users of Anaconda on MS Windows may install these by executing `pip install sphinx nbsphinx` and `conda install -c https://conda.binstar.org/asmeurer pandoc`.

The documentation is built by invoking `make <format>` inside the */doc* directory, where `<format>` is an output format supported by *sphinx*, e.g., `html`. The output will then be found in `/doc/build/<target>`.

0 comments on commit cf3f34e

Please sign in to comment.