pandas-vet icon indicating copy to clipboard operation
pandas-vet copied to clipboard

Published 20 hours ago • verified publisher icon deppen8

Documentation site

Open deppen8 opened this issue 4 years ago • 3 comments

I would like to expand our docs beyond just the README file. A simple Read-the-Docs site or GitHub Page would be good. It should include pages for

  • [ ] README equivalent
  • [ ] Code of Conduct
  • [ ] Contributor Guide
  • [ ] API docs
  • [ ] example usage

deppen8 avatar Aug 05 '19 04:08 deppen8

Working on this at #PyCascades sprints!

keturn avatar Feb 10 '20 21:02 keturn

Current directions:

  • use Read the Docs
  • use Sphinx (not MkDocs)
  • do keep docs-building requirements separate from end-user installation requirements

keturn avatar Feb 10 '20 22:02 keturn

  • keep top-level project README in Markdown
  • use reStructuredText for things in docs/ (including content that's factored out of README)

keturn avatar Feb 10 '20 23:02 keturn