market_prices icon indicating copy to clipboard operation
market_prices copied to clipboard

Documentation (to a doc site)

Open maread99 opened this issue 2 years ago • 0 comments

It would be preferable for documentation to be built with Sphinx or MkDocs and published to a dedicated docs site.

Current documentation consists of:

  • README.md.
  • .ipynb notebook tutorials in docs/tutorials.
  • various .md files in the docs folder.
  • method docstrings (which are comprehensive).

It's all there, but it would be better prestented and easier to navigate if it were on a dedicated docs site.

It hopefully wouldn't be a huge task; the docs files are all .md and the docstrings are (aka 'should be') in numpy format.

Which one, Sphinx or MkDocs? Sphinx is probably more flexible, although would likely involve more work.

maread99 avatar May 19 '22 10:05 maread99