Closed Bug 877197 Opened 8 years ago Closed 3 years ago

Support reST documentation published with Sphinx / ReadTheDocs

Categories

(developer.mozilla.org Graveyard :: General, defect, P2)

x86
macOS
defect

Tracking

(Not tracked)

RESOLVED WONTFIX

People

(Reporter: lorchard, Unassigned)

References

Details

(Whiteboard: [type:feature])

Many Mozilla-related docs are written using reStructuredText, and published as HTML on readthedocs.org:

    https://readthedocs.org/search/project/?q=mozilla

641 results - that suggests a corpus of doco that I really wish was better represented in MDN.

This should be somehow connected to/from MDN, and uses ReadTheDocs.org:

    http://firefox-marketplace-api.readthedocs.org/en/latest/

That uses a Mozilla Sandstone theme for Sphinx:

    https://github.com/ametaireau/mozilla-sphinx-theme

In bug 873256, I made a proof-of-concept theme for RTD/Sphinx. It shares the MDN design and has top-level nav pointing back to MDN.

It might also be interesting to somehow include RTD docs in our search indexing.

And, to make this even more official, we can look into using a developer.mozilla.org domain for docs on RTD
Blocks: 861981
Also, relevant, with regard to my PoC MDN Sphinx theme for bug 873256: I've very hastily hacked together a Sphinx theme based on MDN and used it to build docs for one of my Django projects.

If you want to see how the transition from MDN to RtD looks, try clicking on the "Check out this doc" link on my User page:

    https://developer.mozilla.org/en-US/docs/User:lmorchard

That link should lead to docs for one of my Django apps, here:

    https://django-valet-keys.readthedocs.org/en/latest/

The theme still needs refinement, and will need a complete overhaul whenever we have a redesign. But, it didn't take much work to get it into its current state. Devil's in the details, of course.
No longer blocks: 861981
Priority: -- → P2
Blocks: 861981
Whiteboard: [type:feature]
Component: Editing → General
Depends on: 882919
Summary: Support reST documentation published with ReadTheDocs / Sphinx → Support reST documentation published with Sphinx / ReadTheDocs
Depends on: 882927
Depends on: 891872
Depends on: 889536
Depends on: 920314
See Also: → 1302321
Status: NEW → RESOLVED
Closed: 3 years ago
Resolution: --- → WONTFIX
Product: developer.mozilla.org → developer.mozilla.org Graveyard
You need to log in before you can comment on or make changes to this bug.