Improve the output of the API docs.

Review Request #4535 — Created Sept. 6, 2013 and submitted

Information

Review Board
master

Reviewers

Improve the output of the API docs.

The API docs need a lot of work, and this is one step in that direction.

We now longer show sample XML payloads. While they work, it's preferable
that people just use JSON, so advertise that instead. This has the
benefit of lengthening some very large API doc pages.

The examples now have a sample curl command line for getting the
resource. It also shows the headers that come back.

The description of the resource is now at the top, before the other
details (like URL, child resources, etc.)

Some bullet points have been removed where they just added clutter.

There are some fixes for table layouts. Mostly, this is dealing with
adding CSS classes, which will work with stylesheet changes for the RB
website.

Browsed through a bunch of docs. Looked at the new style and compared
to the old.


Description From Last Updated

Instead of having a border around all edges of the headers, can we just have a bottom border?

daviddavid
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    reviewboard/webapi/resources/filediff.py
    docs/manual/_ext/webapidocs.py
    Ignored Files:

  2. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    reviewboard/webapi/resources/filediff.py
    docs/manual/_ext/webapidocs.py
    Ignored Files:

  2. 
      
chipx86
reviewbot
  1. This is a review from Review Bot.
    Tool: PEP8 Style Checker
    Processed Files:
    reviewboard/webapi/resources/filediff.py
    docs/manual/_ext/webapidocs.py
    Ignored Files:

  2. 
      
reviewbot
  1. This is a review from Review Bot.
    Tool: Pyflakes
    Processed Files:
    reviewboard/webapi/resources/filediff.py
    docs/manual/_ext/webapidocs.py
    Ignored Files:

  2. 
      
david
  1. 
      
  2. Instead of having a border around all edges of the headers, can we just have a bottom border?

    1. Technically, this style change isn't part of this particular change. I'll put that up for review on RBC.

  3. 
      
david
  1. Ship It!

  2. 
      
chipx86
Review request changed

Status: Closed (submitted)

Loading...