Documentation

[maread99]

Originally posted by @gerrymanoim in #61 (comment)

I'd add

• Real documentation

My preference is probably some markdown backed sphinx system on github pages.

@maread99 edit for specific documentation tasks:

• issue template for holiday additions/corrections. Add issue template for holiday additions/corrections #59
• template for new calendars. (see proposal on Add issue template for holiday additions/corrections #59)
• Documentation of ExchangeCalendar 'calendar-defintion' methods/properties.
• Documentation of ExchangeCalendar 'functional' methods/properties (e.g. mintute_to_session_label etc). (completed side option to define minute bounds / test suite overhaul #71)
• Real documentation. To include:
  • API, generated by sphinx
  • content of README.md, to appropriate sections.
  • Reference to tutorials in docs/tutorials.
  • content of .github/pull_request_template.md to appropriate sections (or reference to file)

[maread99]

Would it be worthwhile defining a documentation style? I've been writting documentation for new code in accordance with the numpy style guide which I understand can be read by Sphinx via either the numpydoc extension or (more commonly) the napolean extension.

Style examples here.

[gerrymanoim]

I think numpy is generally what I default to, so fine to "standardize" on that.

[maread99]

#106 added tutorials and overhauled README.md.