Systematic documentation

[oyvfoss]

Want to build a sphinx site for documentation.

• Look into autogeneration from source code in Sphinx.
• Should probably eventually live on readthedocs.
• Create a structure where we can build something useful and add more comprehensive content later!

[oyvfoss]

Added a sphinx project in docs. Compiles right and can build some documentation from source. Good starting point!

Some more thoughts on the docs:

• Should follow the SPDG docs guide
• Want good example notebooks.
• Nice to use the autodoc stuff, but the core of the documentation should be more purposefully written.
• Good starting point:
  • Overview
  • General overview, (could perhaps be on the front page).
  • Tutorials
  • Use notebooks here..
  • Minimal case and expanded one.
  • Processing steps
  • Explain the different steps with formulas and plot examples. Refer to literature.
  • Code structure and functions
  • Quick explanation of the code structure and the different modules.
  • Use the autodoc stuff to print all functions and docstrings.
  • Installation, usage and dendencies
  • Should have links to kval
  • Detailed and good instructions on how to get started.

[oyvfoss]

Documentation is getting better, but keeping this open as a reminder that there are improvements to be done..