Skip to content

Create docs #3

Description

@tmcclintock

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

Here is the TODO checklist:

  • create docs on readthedocs -- done, docs are found here
  • link the docs from the readme.rst page
  • link readme.rst to the index.rst page
  • 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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions