search

pyapp-kit / superqt

Missing widgets and components for Qt-python
https://pyapp-kit.github.io/superqt/
BSD 3-Clause "New" or "Revised" License
210 stars 38 forks source link

[Proposal] Proper Documentation and Website #92

Closed MosGeo closed 2 years ago

MosGeo commented 2 years ago

As this library grows, it would be good to provide documentation on usage. If the proper infrastructure/base for documentation is added, contributors (e.g., me) can add documentations/tutorials as new features/widgets are added. In addition, more users and contributors will come around to the repo.

I don't have much experience with documentation. I started playing to sphinx for one of my side projects but didn't get to actually go deep into it yet. So having the initial structure created by more experienced person would be better. Slowly, we can start to populate the pages.

tlambert03 commented 2 years ago

yep, we need docs. See also #15.

tlambert03 commented 2 years ago

closed by #124, see https://napari.org/superqt/