saltyrtc-server-python icon indicating copy to clipboard operation
saltyrtc-server-python copied to clipboard

Write documentation

Open lgrahl opened this issue 9 years ago • 4 comments

  • [ ] Build and validate docs
  • [ ] Upload docs to saltyrtc.readthedocs.org (+instructions)
  • [ ] Add a section for nginx configuration (mentioned in #17)
  • [ ] Add type annotations

lgrahl avatar Apr 27 '16 22:04 lgrahl

Something with Sphinx on https://readthedocs.org/ would be nice. Alternatively http://www.mkdocs.org/ is really simple.

dbrgn avatar Sep 14 '16 15:09 dbrgn

Definitely Sphinx. Best documentation tool I've ever met. :)

lgrahl avatar Sep 14 '16 15:09 lgrahl

Add a section for nginx configuration (mentioned in #17)

lgrahl avatar Sep 14 '16 15:09 lgrahl

This probably shouldn't have been closed.

dbrgn avatar Sep 26 '16 11:09 dbrgn