Five days ago, I and my friend Dr. Tao Yin fixed and greatly improved pip installation of Qubiter. Today, I am happy to announce that I’ve further enhanced the Qubiter experience by adding its Sphinx generated documentation to the ReadTheDocs website. Check it out.
https://qubiter.readthedocs.io/en/latest/
In technical jargon, the Sphinx software (with the Napoleon extension) can be made to produce beautiful documentation of your Python code, automatically, if the code’s docstrings are in the numpy format, as are Qubiter’s. Sphinx has various themes (skins). Among them is the one provided by the ReadTheDocs people. The ReadTheDocs people will host your documentation, free of charge, except for some ads on the left side bar. Most of the big boys in the qc languages field (for example, Rigetti Pyquil/Forest, Google Cirq, Google OpenFermion, Xanadu PennyLane) already have their documentation on ReadTheDocs. So, the bottom line is, I succumbed to peer pressure and followed the big boys.
Leave a Reply