854942 - Split the API docs off

Status: RESOLVED FIXED

(Marketplace Graveyard :: API, defect, P2)

Description

[Andy McKay]

We'd like to have the API docs in seperate tree inside zamboni. They can stay in the zamboni repo, but this makes it nice for end users so we can separate using zamboni and installing zamboni. We'd like to have read the docs build out this seperate tree.

Comment 1

[Wraithan (Chris McDonald) [:wraithan]]

The split off docs need not live in their own tree, they can still live in docs/ , that way it is easier to pull in common docs between if there are any.

Sphinx relies on the conf.py to tell it what the root doc is, if we have two of those and add some extra commands to the make file they can be side by side.

Also RTD has the ability to select which conf.py you want to use for a given docset, specifically to handle the case where you have two+ sets of docs in a repo.

Comment 2

[Andy McKay]

Sounds great. Would be nice to have a good RTD URL containing the word marketplace or firefox, not zamboni :)

Comment 3

[Chuck Harmston [:chuck]]

Vote: marketplace-api.rtfd.org

Comment 4

[Chuck Harmston [:chuck]]

Taking this bug and moving it to a P2.

Comment 5

[Chuck Harmston [:chuck]]

Landed in two commits (separated to ensure that git appropriately handled renames):

https://github.com/chuckharmston/zamboni/commit/ac33aede9464ae4d9356270146e87a2025e0fc2c
https://github.com/mozilla/zamboni/commit/dd470474a51c9771649b366030cc97a813d2dfe5

New API docs: http://firefox-marketplace-api.readthedocs.org
Old API docs in Zamboni: https://zamboni.readthedocs.org/en/latest/topics/api.html