Open Bug 1665103 Opened 6 years ago Updated 5 years ago

Document glean_parser using markdown rather than rst

Categories

(Data Platform and Tools :: Glean: SDK, enhancement, P4)

enhancement

Tracking

(Not tracked)

People

(Reporter: mdroettboom, Unassigned)

Details

(Whiteboard: [telemetry:glean-rs:backlog])

rst isn't nearly as well known outside of the Python community. The md support in Sphinx is probably good enough at this point that we could use it instead.

pandoc may do a decent job with the conversion (there's not a ton of content), but if not, this may not be worth the effort.

Type: defect → enhancement
Whiteboard: [telemetry:glean-rs:m?] → [telemetry:glean-rs:backlog]
Priority: P3 → P4
You need to log in before you can comment on or make changes to this bug.