Change API docs to use MDN theme

RESOLVED FIXED in 2013-10-28

Status

P5
enhancement
RESOLVED FIXED
6 years ago
5 years ago

People

(Reporter: andy+bugzilla, Assigned: andy+bugzilla)

Tracking

2013-10-28
x86
Mac OS X
Points:
---
Dependency tree / graph

Details

(Whiteboard: [mentor=groovecoder])

(Assignee)

Description

6 years ago
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.
Whiteboard: [mentor=groovecoder]
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.
Severity: normal → enhancement
Priority: -- → P5
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.
Depends on: 873256
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
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.
Who should do QA on this? Marketplace team? Docs team? WebQA?

I assume Marketplace team?
Flags: needinfo?(eshepherd)
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/
Flags: needinfo?(eshepherd) → needinfo?(dbuchner)
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?
Flags: needinfo?(amckay)
(Assignee)

Comment 8

5 years ago
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?
Flags: needinfo?(amckay)
Comment here is good enough for me. :)
Flags: needinfo?(dbuchner)

Comment 10

5 years ago
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
Blocks: 918885
No longer blocks: 918885
Les just opened a pull request about this.

https://github.com/mozilla/zamboni/pull/1188
Blocks: 918885
(Assignee)

Comment 12

5 years ago
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.
(Assignee)

Updated

5 years ago
Assignee: nobody → amckay
Target Milestone: --- → 2013-10-28
(Assignee)

Updated

5 years ago
Status: NEW → RESOLVED
Last Resolved: 5 years ago
Resolution: --- → FIXED
You need to log in before you can comment on or make changes to this bug.