qir-alliance / pyqir

PyQIR is a set of APIs for generating, parsing, and evaluating Quantum Intermediate Representation (QIR).
https://qir-alliance.github.io/pyqir
MIT License
54 stars 24 forks source link

Simplify Sphinx docs structure, update theme, and fix docstring bugs #208

Closed bamarsha closed 1 year ago

bamarsha commented 1 year ago

The docs folder structure seemed overly complicated and was hard to navigate, with too many empty index pages. I flattened the structure so that there are fewer pages and folders.

I also did the opposite for the API reference page (splitting it out into a folder) since it's very long, and the api/index page is a useful outline.

I don't think the Alabaster theme is very readable, so I switched Furo, which I think looks a lot nicer, and also has a dark mode.

I fixed a lot of bugs with missing documentation and enabled intersphinx links to the Python docs for stdlib types.