FrisPy icon indicating copy to clipboard operation
FrisPy copied to clipboard

Create docs

Open tmcclintock opened this issue 5 years ago • 0 comments

Use the basic sphinx build and host on either RTD or github pages.

Here is the TODO checklist:

  • [x] create docs on readthedocs -- done, docs are found here
  • [x] link the docs from the readme.rst page
  • [x] link readme.rst to the index.rst page
  • [x] translate README.md into rst
  • [ ] add a page describing the mathematics
  • [ ] add a page on the Model object and how to set your own values to try different flights
  • [ ] generate figures in a notebook and add them to the docs
  • [ ] use autoapi to split up the submodules more nicely

tmcclintock avatar Dec 07 '20 03:12 tmcclintock