889536 - Change API docs to use MDN theme

Status: RESOLVED FIXED

(Marketplace Graveyard :: API, enhancement, P5)

Description

[Andy McKay]

There's an MDN theme now:

https://github.com/lmorchard/mozilla-mdn-sphinx-theme

Example:

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

We should use that for the API docs.

Comment 1

[Les Orchard [:lorchard]]

One caveat: That MDN theme is a prototype, just to get the ball rolling. It's the product of me copying & pasting from View Source on MDN and spinning up a theme while in between sessions at a conference.

It could use a lot of work to become serious business. Suggestions welcome.

Comment 2

[Luke Crouch [:groovecoder]]

FWIW, the MDN dev theme will probably pull this into our own queue of work to further prove and refine our concept for externally-sourced content zones on MDN.

Comment 3

[Jannis Leidel [:jezdez]]

For the record, I've opened a pull request for the Sphinx theme repo to make it capable of packaging. This would ease the installation/configuration in new Sphinx docs dramatically (~"Just pip install it!"). https://github.com/lmorchard/mozilla-mdn-sphinx-theme/pull/1

Comment 4

[Les Orchard [:lorchard]]

Needs work & has bugs, but here's my first attempt at running the Marketplace API docs through our new MDN theme:

    https://mdn-firefox-marketplace-api.readthedocs.org/en/latest/

Not quite ready for a pull request, but this is what I did so far:

    https://github.com/lmorchard/zamboni/commit/8089e2ac6f5d5e4ea99d474c5933a6a65ab2feda

Next steps are to look through that rendering of the API docs and make a note of anything that's broken or needs changing in general to make this theme acceptable.

Comment 5

[Luke Crouch [:groovecoder]]

Who should do QA on this? Marketplace team? Docs team? WebQA?

I assume Marketplace team?

Comment 6

[John Karahalis [:openjck]]

Daniel, can you please take a look at our first attempt at Marketplace API documentation and let us know what you think? Les can say more about what exactly he was hoping to get feedback on. Please let either of us know if you have any questions.

https://mdn-firefox-marketplace-api.readthedocs.org/en/latest/

Comment 7

[Luke Crouch [:groovecoder]]

Can Marketplace check out https://mdn-firefox-marketplace-api.readthedocs.org/en/latest/ and let us know if it looks good enough to send a pull request and ship it?

Comment 8

[Andy McKay]

I can see a few visual bugs such as the character on the end of titles:

http://cl.ly/image/3k340r050S0d

Note being on a seperate line:

http://cl.ly/image/0g432j2z271m

And this:

http://cl.ly/image/3Y050a0J0B0h

Should we file separate bugs for these?

Comment 9

[Luke Crouch [:groovecoder]]

Comment here is good enough for me. :)

Comment 10

[[github robot]]

Commits pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/4b7f377080b2e810f51560e438cf7af1f7a35df9
bug 889536 - mdn sphinx theme cleanup

https://github.com/mozilla/kuma/commit/2ef54cd8ae639c0bd86deaf8ad645603385edb3f
Merge pull request #1316 from groovecoder/sphinx-theme-cleanup-889536

bug 889536 - mdn sphinx theme cleanup

Comment 11

[John Karahalis [:openjck]]

Les just opened a pull request about this.

https://github.com/mozilla/zamboni/pull/1188

Comment 12

[Andy McKay]

Wanted to do it in a slightly different way, so landed:

https://github.com/mozilla/zamboni/commit/4434c7

Also did solitude, webpay, zippy. When the new beta skin lands in the theme it would be awesome.