Project

General

Profile

Feature #1701

API: documentation

Added by Alexander Watzinger 7 months ago. Updated 18 days ago.

Status:
In Progress
Priority:
Normal
Category:
API
Target version:
Start date:
2022-04-27
Estimated time:

Description

Although we already have an API documentation, thanks to Bernhard, we should think about an overhaul to make it more accessible for beginners and experts alike.

A few ideas:
  • We could take inspiration from successful API documentations, e.g. selected API examples
  • Maybe switch to the in-application Sphinx documentation. It looks better and would have the advantage to always be the right documentation for the right version
  • Should be written primarily by Bernhard Koschiček-Krombholz but
    • Maybe Nina Richards could support with her excellent writing skills and with her perspective as an API beginner
    • We could ask API interested people about feedback e.g. Eugen Hotwagner

Related issues

Related to OpenAtlas - Feature #1751: Manual: add model documentationClosed2022-08-29Actions

History

#1

Updated by Alexander Watzinger 7 months ago

  • Description updated (diff)
#2

Updated by Alexander Watzinger 5 months ago

  • Related to Feature #1751: Manual: add model documentation added
#3

Updated by Alexander Watzinger 4 months ago

  • Status changed from Assigned to In Progress
#4

Updated by Bernhard Koschiček-Krombholz 4 months ago

  • Target version changed from 208 to 7.7.0
#5

Updated by Bernhard Koschiček-Krombholz about 2 months ago

  • Target version changed from 7.7.0 to 7.8.0
#6

Updated by Alexander Watzinger 18 days ago

  • Target version changed from 7.8.0 to 7.9.0

Also available in: Atom PDF