Redo the index page for the API docs for better guidance/organization.

Review Request #9377 — Created Nov. 15, 2017 and submitted

Information

Review Board
release-3.0.x
0935a32...

Reviewers

The index page for the API documentation was nothing but a giant
toctree, which didn't really provide any guidance at all. This has been
replaced with a new index page that gives a brief overview of the API,
followed by sections on:

  • Getting started with the API (containing the overview, authentication,
    and glossary)
  • API bindings available (linking to the RBTools Python API docs)
  • Working with special data (currently consisting of rich text fields
    and, later, extra_data handling)
  • Available resources (linking to the resource tree and categories)
  • Errors (linking to the full list of errors)

It also gets rid of any mention of the old API 1.0 docs, which isn't
worth including anymore.

Checked for build and spelling errors.

Tested that the links pointed to the right places.

david
  1. Looks pretty good but this will need an update to include the oauth2 docs I just pushed.

  2. 
      
chipx86
david
  1. Ship It!
  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Change Summary:

Pushed to release-3.0.x (6ca6afd)
Loading...