Add documentation

[ots22]

• [x] Docstrings for modules, classes and major functions
• [ ] Sphinx doc description: include set visualisation in the description (in addition to missingness)
• [ ] Landing page: general description of the package and show a basic example
• [ ] Overview: complete this page (or remove)
• [ ] Link to the tutorial (or: include notebooks in sphinx pages?)
• [x] Add instructions to README for building the docs

[layik]

95

Can I just check if we meant to use pydata_sphinx_theme (in conf.py) rather than sphinx-rtd-theme and also whether the latter is the "readthedocs" theme? Thanks.

[layik]

the latter is the "readthedocs" theme? Thanks.

Yep just tried it. Can I change the entry to sphinx_rtd_theme please? As it looks much better.

[ots22]

The pydata theme was a deliberate choice, partly to make it consistent with other python data science tooling (numpy, pandas etc all use it).

Personally I prefer this theme though! Is there anything we could adjust to make it look nicer in your view?

[ots22]

I ticked the docstrings box, since I think we're pretty much done with these now - can open new issues with anything we want to tweak.

[layik]

The pydata theme was a deliberate choice, partly to make it consistent with other python data science tooling (numpy, pandas etc all use it).

Great. Glad it's a deliberate choice.

Personally I prefer this theme though! Is there anything we could adjust to make it look nicer in your view?

Nothing specific, I am possibly too used to rtd.

[layik]

Related #109

[layik]

Overview page is empty?

https://setvis.readthedocs.io/en/latest/overview.html

[ots22]

Thanks, added to the list!