There are a lot of backslashes in the place of where [OUT] would expected to be seen in the ipython generated latex.
For example:

\PYG{g+go}{\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}\PYGZbs{}

(this actually goes on much longer, I just copied a fraction of it)

Does not appear in the HTML output

The sphinx Ipython directive parser breaks for functions. See ipython/ipython#11362

This breaks our documentation build as the code blocks in qutip-doc/guide/dynamics/dynamics-bloch-redfield.rst define some functions which cannot be produced by the Ipython directive. I spent a lot of time trying to make this work but to no avail.

I have a completely new version of the docs where I setup Sphinx from scratch which does not require the Ipython directive to run. The only catch is that we have to manually run the code blocks and generate the output and put them in the docs. I am trying to find other automated ways but would actually be happy to move from Ipython and just use the doc-test directive provided by Sphinx.

@nathanshammah @ajgpitch Let me know what do you think? It is time we update the documentation generator.

Matplotlib removed the sphinx directives and they are a part of Ipython now. See issue. So anyone on the latest Sphinx will face an error when trying to build the documentation.

This was also faced in #62. I have a version of the docs built from scratch with the latest sphinx which should fix this. Just thinking of the best way to deal with figures and output without using IPython at all as it leads to other issues.

Running Sphinx v1.8.4

Extension error:
Could not import extension matplotlib.sphinxext.only_directives (exception: No module named 'matplotlib.sphinxext.only_directives')
make: *** [html] Error 2

Hi
I can't update qutip to last version
What I do?

In trying to get the doc build working, I ran make html with an up-to-date Sphinx installation and got the following error:

Exception occurred:
  File "/home/cgranade/academics/software-projects/qutip-doc/_sphinxext/plot_directive.py", line 633, in run
    fd = open(source_file_name, 'r')
IOError: [Errno 2] No such file or directory: u'/home/cgranade/academics/software-projects/qutip-doc/../qutip/qutip/examples/ex_50.py'

The mentioned directory, ../qutip/ is the correct location for my local clone of qutip/qutip, but there doesn't seem to be an examples folder at all in qutip/qutip@a44a3c3. The only mention I can find of ex_50.py is in README.txt.

As can be seen in the image, there is a duplicate entry for 'Monte Carlo Solver' in the sidebar of the html documentation. It appears on different browsers and operating systems, so I believe it to be a misconfiguration in the docs themselves.

I'm happy to work on this, although I don't have much experience with sphinx.

Hi,

It seems some of the functions in the qutip.floquet module are not documented in the doc. For instance, for qutip.floquet.floquet_master_equation_rates, there is no found documentation.

Not sure if this is on purpose or not, especially since these functions should have a valid docstring.

EDIT: This is also the case for many other functions in qutip.floquet module, such as qutip.floquet.steadystate which seems to be really useful.

Using sphinx-doctest allows to test the examples in rst. The doctest directive for interactive code blocks allows to test examples. For static blocks this can be done with testcode (matched by testoutput and eventually with the ghost block testsetup).

The beautiful tree-diagram of the user accessible functions and classes have not been updated for a long time. I am trying to understand how it is visualized using D3.js and possibly writing an automated script to update it with new documentation. For now, I would suggestion removing it from the documentation and it is outdated.

http://qutip.org/docs/latest/guide/guide-overview.html#figure-qutip-org

Change from qutip_dev_contrib.md to CONTRIBUTING.md to appear in the GH community profile, as apparently standard. Would need to change the file name and instances where it occurs (search for qutip_dev_contrib in Github).

Working in my branch:https://github.com/Ericgig/qutip-doc/tree/build4.4
I have problem building the doc.
Main errors
RuntimeError: Non Expected exception in qutip-doc/guide/guide-states.rst line 615
and
qutip-doc/guide/guide-visualization.rst line 331
Any help appreciated.
ps. matplotlib 2.3, scipy 1.2, recent version don't work.
patch for scipy 1.3 comming.

@ajgpitch created a great recipe file for maintainers making a new qutip release. Some nice labels are given at the beginning of the file but the anchors are not found in the rst file, such as #sdist
in https://github.com/qutip/qutip-doc/blob/master/release_distribution.rst#sdist

There are several libraries that rely on QuTiP for quantum physics or quantum information processing. Examples include Krotov, Matsubara and PyEPR. It would be nice to have a place in the documentation (and on the qutip website, possibly even beyond the documentation) where these are listed, with links taking to them and a short, one line description.

A difference could be made in cathegorizing them between "libraries using QuTiP" and "QuTiP plugins" (they heavily rely on QuTiP for basic functionalities).

The Github tool "Used by" could be used for to find all of the former that are just not forks.

@nonhermitian I am very happy with the idea that we state clearly that we will only offer support for qutip on Windows using Python 3.5+ and Visual Studio as the compiler. However, there are some users who don't have the ~10GB free needed for Visual Studio 2015. I have just been helping such a student here.

I see in the latest version of the installation docs we no longer give any information on installing qutip on Windows with Python 2.7 / 3.4. Can I add something on distutils.cfg and mingwpy? This seems to work ok with the new c++ extensions.

The latest conda version of sphinx 1.5.1 fails to build the latex documentation
Doesn't like any biblio entries.

! LaTeX Error: \begin{bibitemlist} on input line 1547 ended by \end{sphinxthebibliography}.

Builds ok with sphinx 1.4.6
I think it's related to sphinx-doc/sphinx#2629
Anyway, I have tried with docclass 'manual', and ditching our preamble, and I think it looks better anyway.
@nonhermitian I am going to proceed this way unless anyone says that memoir is essential.

Hi,

After installing the required dependencies and cloning the repo, I issued the following command:

make html

and got the following error:

Extension error:
Could not import extension matplotlib.sphinxext.only_directives (exception: No module named 'matplotlib.sphinxext.only_directives')
make: *** [latexpdf] Error 2

What am I doing wrong? Can anyone help me fix this please? Thanks!

Suggestion to add tutorial to build a fluid simulator based on quantum physics. It would a good exercise for learners.

The QuTiP documentation page does not appear to have a convenient navigation bar link back to the main QuTiP site.

The documentation can be built according to the Readme.

For 4.5.0, make html fails due to problems in Ipython.

It picks up some issues in guide-visualization after line 399.

It seems that IPython has become more strict.
pandas-dev/pandas#23257

This seems a possible fix:
ipython/ipython#11402 (comment)

How should I build docs locally ?

I am making changes to docstrongs in qutip/qutip and I want to test the build. For this, I have a clone of qutip/qutip folder but the makefile is in qutip-doc. Should I clone qutip-doc in the local folder of qutip/qutip ?

@nathanshammah @sahmed95
Documentation is required for Models and specifically PIQS

Does not need a lot. Can just copy some stuff from the intro notebook
Also the module needs linking for the API docs

At this link, a line is given to install doc build dependencies. The problem is that it installs the latest version of Sphinx which has an issue with missing colon when documentation is built.

When I build documentation locally, the colon in the screenshot after inpt below does not appear.

I use Python 3.8 in my virtual environment which is incompatible with the Sphinx version specified in this configuration file. So, to install this older version of Sphinx, a user will also have to make sure they switch to Python 3.6. This will also end up installing older versions of many dependencies.

For more information, see the fix applied by RTD and the issues references within for an earlier version of Sphinx . One of the issues in the RTD link discusses enforcing the build in html4 or making changes in CSS to avoid this error (don't know if any of these would fix it or not).

QuTiP's read-the-docs badge, which should tell if the documentation is building correctly, says it is failing. This could be related also to the way qutip's documentation is built, not from qutip/qutip, but from qutip/qutip-doc.

It looks like the latest API documentation has a problem (unless this is a display problem on my end only - in which case I must apologize).

Example: looking at http://qutip.org/docs/latest/apidoc/classes.html#qobj , what I see as the first two Parameters of Qobj is:
inptarray_like
dimslist

I suspect this should be inpt: array_like and dims: list
Is this an issue related to the space preceding the colon in the corresponding docstrings in the qutip source code?

Simply installation guide. Default to Anaconda on all platforms.

This page refers to qutip.visualization.wigner_cmap which does not seem to be available (see https://github.com/qutip/qutip/blob/master/qutip/visualization.py).

I guess it should use the plot_wigner function instead?

The documentation for quantum optimal control has numerous numbered references within the text, however there is no bibliography detailing what papers are being referenced.