nathanshammah / piqs

Permutational Invariance Quantum Solver for Lindblad open quantum system dynamics
BSD 3-Clause "New" or "Revised" License
17 stars 8 forks source link

Documentation and webpage #27

Closed quantshah closed 6 years ago

quantshah commented 6 years ago

Generating documentation and a webpage for PIQS. The build is done with Sphinx and can be triggered by installing sphinx first with conda install sphinx numpydoc sphinx_rtd_theme and then running the make command inside the doc/source folder with

make html

Any addition to the ".md" and ".rst" files in doc/source will be used to build the documentation. We can directly put this in read-the-docs once completed.