Closed Bug 1411430 Opened 7 years ago Closed 7 years ago

Support markdown in Sphinx docs

Categories

(Firefox Build System :: General, defect)

Product:
Firefox Build System
Component:
General
Type:
defect
Priority:
Not set
Severity:
normal

Tracking

(firefox58 fixed)

Status:
RESOLVED FIXED
Milestone:
mozilla58
Tracking Flags:
Tracking Status
firefox58 --- fixed

People

(Reporter: impossibus, Assigned: impossibus)

References

Details

Attachments

(1 file)

Bug 1411430 - Support markdown in Sphinx docs;
59 bytes, text/x-review-board-request
gps
: review+
Details 
Let's allow markdown in Mozilla Source Tree Docs. 

marionette and geckodriver have documentation written in markdown, for example.
Comment on attachment 8921665 [details]
Bug 1411430 - Support markdown in Sphinx docs;

https://reviewboard.mozilla.org/r/192662/#review198368

r- because ``build/sparse-profiles/sphinx-docs`` will also need updated. r+ with that change.

FWIW I'm not too familiar with Sphinx's support for Markdown. Given that ReST is designed to be an extensible markup language and Markdown isn't as nicely a designed language, I'm skeptical that enabling Markdown will enable anything more than the ability to render simple documents into the docs. But I see little harm in enabling Markdown. So let's do it.
Attachment #8921665 - Flags: review?(gps) → review-
Comment on attachment 8921665 [details]
Bug 1411430 - Support markdown in Sphinx docs;

https://reviewboard.mozilla.org/r/192662/#review198806
Attachment #8921665 - Flags: review?(gps) → review+
Pushed by gszorc@mozilla.com:
https://hg.mozilla.org/integration/autoland/rev/c1191b82382a
Support markdown in Sphinx docs; r=gps
https://hg.mozilla.org/mozilla-central/rev/c1191b82382a
Status: NEW → RESOLVED
Closed: 7 years ago
status-firefox58: --- → fixed
Resolution: --- → FIXED
Target Milestone: --- → mozilla58
Product: Core → Firefox Build System
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Creator:
Created:
Updated:
Size: