universal_pathlib icon indicating copy to clipboard operation
universal_pathlib copied to clipboard

docs: provide documentation on readthedocs

Open ap-- opened this issue 1 year ago • 0 comments

Should start hosting documentation on RTD.

  • [ ] decide between sphinx and mkdocs
  • [ ] port the readme to the hosted docs and reduce the readme to a quickstart section
  • [ ] ingest the example notebook as a tutorial section
  • [ ] add ci job for deploying the docs
  • [ ] add links to readme
  • [ ] add project owners to rtd project

ap-- avatar Dec 16 '24 13:12 ap--