Impove documentation for rich text support in the API.
Review Request #6535 — Created Oct. 29, 2014 and submitted
This introduces a new page detailing how the rich text support works in
the API. It covers the text types, entries in extra_data, forcing text
types, and more.All existing resources have had their custom docs on rich text support
removed in favor of the new page. These resources also now have the
"supports_text_types" flag set for the POST/PUT fields.The docs generator uses this flag when building the request/response
field tables. If set, it will override the field's text type to
"Rich Text," and link to the new documentation.
Built the docs and looked at all the impacted resource docs. Things looked
fine from what I could see.Tested that the links worked.
Tool: Pyflakes Processed Files: reviewboard/webapi/resources/base_comment.py reviewboard/webapi/resources/review_request_draft.py reviewboard/webapi/resources/review_reply_file_attachment_comment.py reviewboard/webapi/resources/review_file_attachment_comment.py reviewboard/webapi/resources/review_screenshot_comment.py reviewboard/webapi/resources/change.py reviewboard/webapi/resources/review_request.py reviewboard/webapi/resources/file_attachment_comment.py reviewboard/webapi/resources/screenshot_comment.py reviewboard/webapi/resources/base_review.py reviewboard/webapi/resources/review_reply_diff_comment.py reviewboard/webapi/resources/review.py reviewboard/webapi/resources/review_reply_screenshot_comment.py docs/manual/_ext/webapidocs.py reviewboard/webapi/resources/filediff_comment.py reviewboard/webapi/resources/review_diff_comment.py reviewboard/webapi/resources/review_reply.py Ignored Files: docs/manual/webapi/2.0/rich-text-fields.rst docs/manual/webapi/2.0/index.rst docs/manual/webapi/index.rst Tool: PEP8 Style Checker Processed Files: reviewboard/webapi/resources/base_comment.py reviewboard/webapi/resources/review_request_draft.py reviewboard/webapi/resources/review_reply_file_attachment_comment.py reviewboard/webapi/resources/review_file_attachment_comment.py reviewboard/webapi/resources/review_screenshot_comment.py reviewboard/webapi/resources/change.py reviewboard/webapi/resources/review_request.py reviewboard/webapi/resources/file_attachment_comment.py reviewboard/webapi/resources/screenshot_comment.py reviewboard/webapi/resources/base_review.py reviewboard/webapi/resources/review_reply_diff_comment.py reviewboard/webapi/resources/review.py reviewboard/webapi/resources/review_reply_screenshot_comment.py docs/manual/_ext/webapidocs.py reviewboard/webapi/resources/filediff_comment.py reviewboard/webapi/resources/review_diff_comment.py reviewboard/webapi/resources/review_reply.py Ignored Files: docs/manual/webapi/2.0/rich-text-fields.rst docs/manual/webapi/2.0/index.rst docs/manual/webapi/index.rst