google / qhbm-library

Quantum Hamiltonian-Based Models built on TensorFlow Quantum
https://qhbm-library.readthedocs.io/en/latest/
Apache License 2.0
40 stars 15 forks source link

Add sphinx and Read the Docs #240

Closed zaqqwerty closed 2 years ago

zaqqwerty commented 2 years ago

Resolves #27

Adds infrastructure for using Sphinx to generate documentation from code. Initial index.rst and reference.rst added to generate the docs. .readthedocs.yaml tweaks the default Read the Docs build to read from our Poetry compatible pyproject.toml

This build can be viewed at https://qhbm-library--240.org.readthedocs.build/en/240/. Currently LaTeX in docstrings does not render, see #242

farice commented 2 years ago

Sorry just saw the last line of the desc - do we want to add this extension integration now or defer to another PR?

zaqqwerty commented 2 years ago

Not sure what it will take to enable, so I'm thinking getting a first draft of docs up first would be good.