20c/django-handleref

Documentation Pass

Closed this issue · 1 comments

vegu commented

Currently all of the documentation we have is in the readme file. They should be moved to a /docs directory

  • make a /docs directory
  • quickstart.md with install instructions and example
  • examples.md with rest of examples
  • mkdocs configuration
  • github workflow to generate documentation to gh-pages
  • add /docs/api directory and use pymdgen to autogenerate api docs

Added documentation for APIs except for models.py as that is giving an error.