workbench icon indicating copy to clipboard operation
workbench copied to clipboard

Make the API documentation for ReadTheDocs awesome (300 cow points)

Open brifordwylie opened this issue 11 years ago • 2 comments

http://python-ssdeep.readthedocs.org/en/latest/ clearly has some logic around how the API docs are setup and organized. We need to do something similar.

We'll have a couple categories of API docs (like ssdeep has)

  • Workbench server commands
  • Workers API
  • Clients (we might think about having each client have a gigantic docstring saying what it does and then show code)

brifordwylie avatar Jul 02 '14 17:07 brifordwylie

Also, correct issues , like the robot on the installation page.

iamkhush avatar Jul 03 '14 20:07 iamkhush

bump in priority on this.. also lets get rid of the constraint that docs generated by 'tox' have to be NOT checked in.. .

brifordwylie avatar Jul 19 '14 21:07 brifordwylie