QuTiP documentation
TeX Python HTML Makefile Other
Latest commit 7570f92 Mar 29, 2017 @ajgpitch ajgpitch committed on GitHub Merge pull request #51 from ajgpitch/v4.1-reldist_updates
V4.1 reldist updates
Permalink
Failed to load latest commit information.
QuTiP_tree_plot doc updates Feb 20, 2016
apidoc updates for 4.1 Mar 12, 2017
contrib
figures updated logo Jul 8, 2014
guide updates for 4.1 Mar 12, 2017
latex_input_files-not_used Latex premamble but back Jan 10, 2017
sphinxext add github fix Mar 13, 2017
static add github fix Mar 13, 2017
templates add github fix Mar 13, 2017
.gitattributes Support for Windows-based doc builds. Mar 21, 2016
.gitignore Fixes for ipython savefig Jan 8, 2017
Makefile MakeFiles returned to previous form Jan 9, 2017
README.md latex_keep_old_macro_names back to True Mar 28, 2017
biblio.rst Added bibliography entries for random sampling. Feb 15, 2015
changelog.rst one more item to changelog Mar 11, 2017
conf.py latex_keep_old_macro_names back to True Mar 28, 2017
contributors.rst fixed url Dec 26, 2014
current_version.txt Attempt at fixes in many places Jan 7, 2017
frontmatter.rst updates for 4.1 Mar 12, 2017
index.rst updates for 4.1 Mar 12, 2017
installation.rst changes to building the conda env Mar 24, 2017
make.bat MakeFiles returned to previous form Jan 9, 2017
release_distribution.rst Release distribution docs updated Mar 28, 2017

README.md

Repository for QuTiP documentation

This repository contains the source files for the QuTiP documentation.

For pre-built documentation, see http://www.qutip.org/documentation.html

Build requirements

2017-03-28: Successful building using:

  • sphinx v1.5.1
  • numpydoc v0.6.0
  • ipython 5.1.0

Build

2017-01-07: Thanks to some bug in ipython/ipython#8733 to do with the ipython_savefig_dir conf option, then note that this build directory structure must exist already:

_build/html/_images
_build/latex/_images

To build the documentation on Linux or OS X run:

$ make html latexpdf

Building Documentation On Windows

Building the HTML documentation requires Sphinx and numpydoc, both of which can be installed using Anaconda:

> conda install sphinx numpydoc

If you installed QuTiP using another distribution of Python, these dependencies can also be installed using either easy_install or pip:

> easy_install install sphinx numpydoc
> pip install sphinx numpydoc

To build the HTML documentation on Windows using cmd.exe, run:

> make html

From PowerShell, run:

PS> .\make html