Last Comment Bug 854942 - Split the API docs off
: Split the API docs off
Status: RESOLVED FIXED
p=1
:
Product: Marketplace
Classification: Server Software
Component: API (show other bugs)
: 1.0
: All All
: P2 normal (vote)
: 2013-04-18
Assigned To: Chuck Harmston [:chuck]
:
:
Mentors:
Depends on:
Blocks:
  Show dependency treegraph
 
Reported: 2013-03-26 09:54 PDT by Andy McKay [:andym]
Modified: 2013-04-15 12:38 PDT (History)
2 users (show)
See Also:
QA Whiteboard:
Iteration: ---
Points: ---


Attachments

Description Andy McKay [:andym] 2013-03-26 09:54:44 PDT
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] 2013-04-11 09:43:05 PDT
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 [:andym] 2013-04-11 10:41:44 PDT
Sounds great. Would be nice to have a good RTD URL containing the word marketplace or firefox, not zamboni :)
Comment 3 Chuck Harmston [:chuck] 2013-04-11 10:42:12 PDT
Vote: marketplace-api.rtfd.org
Comment 4 Chuck Harmston [:chuck] 2013-04-15 10:27:32 PDT
Taking this bug and moving it to a P2.

Note You need to log in before you can comment on or make changes to this bug.