The default bug view has changed. See this FAQ.

Split the API docs off

RESOLVED FIXED in 2013-04-18

Status

Marketplace
API
P2
normal
RESOLVED FIXED
4 years ago
4 years ago

People

(Reporter: andym, Assigned: chuck)

Tracking

2013-04-18
Points:
---

Details

(Whiteboard: p=1)

(Reporter)

Description

4 years ago
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.
Assignee: nobody → xwraithanx
Target Milestone: --- → 2013-04-04
Target Milestone: 2013-04-04 → ---
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.
(Reporter)

Comment 2

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

Comment 3

4 years ago
Vote: marketplace-api.rtfd.org
(Assignee)

Comment 4

4 years ago
Taking this bug and moving it to a P2.
Assignee: wraithan → charmston
Priority: P4 → P2
(Assignee)

Comment 5

4 years ago
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
Assignee: charmston → wraithan
Status: NEW → RESOLVED
Last Resolved: 4 years ago
Priority: P2 → P4
Resolution: --- → FIXED
(Assignee)

Updated

4 years ago
Assignee: wraithan → charmston
OS: Mac OS X → All
Priority: P4 → P2
Hardware: x86 → All
Target Milestone: --- → 2013-04-18
You need to log in before you can comment on or make changes to this bug.