Add documentation for the new webhook resource.
Review Request #7524 — Created July 14, 2015 and submitted
This change adds the pieces needed to generate docs for the new webhook
resource. Specifically, it adds new doc entries for webhook-list and webhook,
links in the index, and a fixture to auto-generate examples from.While I was doing this, I encountered lots of trouble because the types for the
apply_to,encoding, andtypefields weren't correct (they were lists of
specific strings rather than just being a genericsix.text_type). This was
causing the docs to fail to build in a cryptic way as thewebapi-resource
sphinx class tried to import "a.ll"
Build docs and looked at the results.
-
-
reviewboard/webapi/resources/webhook.py (Diff revision 1) It was actually correct before, except that it should have been a tuple, not a list. Tuples define possible choices, and validation will take those into account.
-
-
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+42 -6) |
-
Tool: PEP8 Style Checker Processed Files: reviewboard/notifications/models.py reviewboard/webapi/resources/webhook.py Ignored Files: docs/manual/webapi/2.0/resources/web-hook.rst docs/manual/fixtures/initial_data.json docs/manual/webapi/2.0/resources/index.rst docs/manual/webapi/2.0/resources/web-hook-list.rst Tool: Pyflakes Processed Files: reviewboard/notifications/models.py reviewboard/webapi/resources/webhook.py Ignored Files: docs/manual/webapi/2.0/resources/web-hook.rst docs/manual/fixtures/initial_data.json docs/manual/webapi/2.0/resources/index.rst docs/manual/webapi/2.0/resources/web-hook-list.rst
Tool: Pyflakes Processed Files: reviewboard/webapi/resources/webhook.py Ignored Files: docs/manual/webapi/2.0/resources/webhook.rst docs/manual/fixtures/initial_data.json docs/manual/webapi/2.0/resources/index.rst docs/manual/webapi/2.0/resources/webhook-list.rst Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/resources/webhook.py Ignored Files: docs/manual/webapi/2.0/resources/webhook.rst docs/manual/fixtures/initial_data.json docs/manual/webapi/2.0/resources/index.rst docs/manual/webapi/2.0/resources/webhook-list.rst