Giters

AuHau / toggl-cli

A simple command-line interface for toggl.com

Home Page:https://toggl.uhlir.dev

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

API reference documentation

AuHau opened this issue · comments

commented

Currently, there is no detailed API wrapper's reference, where detailed signatures are explained for the wrapper classes.

There are few criteria from my side:

  • Needs to be generated from doc-strings (otherwise it will get stale very fast as people are lazy to update hand-written reference, me included).
  • Needs to be compatible with mkdocs (I am not a big fan of reST and Sphinx).

Currently, I am aware of pydoc-markdown, but the current version does not support documentation of class's attributes. There is a new version being developed which will support it but for now, I am not aware of any other solutions, so if you know about any please let me know!