MarcSerraPeralta / iq_readout

Classifiers for IQ readout data from superconducting qubits
https://iq-readout.readthedocs.io/en/latest/
MIT License
1 stars 0 forks source link

Create "Read the Docs" webpage #18

Closed MarcSerraPeralta closed 2 months ago

MarcSerraPeralta commented 2 months ago

Use "Read the Docs" and Sphinx to create a webpage with the documentation. Sphinx allows to show plots in the documentation (as well as equations) which is helpful to see how the PDFs look like. ReadtheDocs can host the Sphinx documentation in a website, which is easier to read than through github.

TODO

MarcSerraPeralta commented 2 months ago

Find here a tutorial on how to use Sphinx to document a repo and how to publish it in ReadtheDocs:

https://sphinx-rtd-tutorial.readthedocs.io/en/latest/index.html