Revamp RBTools API documentation.

Review Request #14497 — Created July 7, 2025 and updated — Latest diff uploaded

Information

RBTools
master

Reviewers

This change revamps the main portion of the RBTools API docs to make it
much easier to get started. These changes include:

Significantly reworked and expanded the "Overview" page. This
includes:

  • Start with the tiniest example that can just instantiate the client
    and get the root resource.
  • Authentication options (new).
  • What resources are (new).
  • How to access resource data (simplified).
  • How to iterate over list resources (new).
  • How to navigate links between resources (simplified).
  • Request parameters (simplified)
  • Expanding resources (new)
  • Limiting data (new)
  • Error handling (new)

Renamed "Tutorial" to "Common Use Cases", and updated the content with
improved examples and better Python practices.

Removed the old "Resource Specific Functionality" page, since all of
these are now properly documented in the docs for each resource
subclass.

Built HTML and checked the output.

Commits

Files