quantumlib / OpenFermion-Cirq

Quantum circuits for simulations of quantum chemistry and materials.
Apache License 2.0
276 stars 87 forks source link

Full docstrings not appearing in built documentation #399

Closed bryano closed 4 years ago

bryano commented 4 years ago

For example, openfermioncirq.ffft. The first line does appear on the module page but the function page appears blank. This is true both on RTD and locally built docs (at least for me). Having randomly sampled several functions, I have yet to see one for which this isn't true. (The docstrings for classes seem to be working fine.)

This would be nice to fix especially for docstrings with a lot of tex; they're meant to be read in a browser.