Sentry REST API documentation #475
Description
We need a way to easily document the REST API of sentry in using rustdoc.
Two ideas come to mind:
Doc macro for serialization inside the doc comments- It's more difficult than expected, this is put on hold- Building json/queries example files using Rust and include them inside the docs
Doc macro for serialization (on hold)
We need to serialize to json & urlencode fir structs inside doc comments.
A similar macros to https://github.com/scrabsha/dep-doc with arguments of rust structs and expression:
let my_struct = MyStruct { field: .. }
with the following variants:
doc_urlencode!- urlencode the struct and print it in docsdoc_json!- pretty-print the struct in json format inside the docs
Building docs
We now build docs based on aip-61-adex-v5 branch with default path to sentry crate and we deploy it with GH pages at: