New API documentation website

Registered by Michael Hall

Develop new dynamic, extensible API website to replace generated static HTML docs

Blueprint information

Not started
Jono Bacon
Michael Hall
Needs approval
Michael Hall
Series goal:
Accepted for saucy
Milestone target:
milestone icon ubuntu-13.10

Related branches




Work Items

Work items for ubuntu-13.05:
[mhall119] Finish updating Spec: DONE
[mhall119] Switch development focus branch: DONE
[dpm] Deploy new API doc publisher script with PPA support (automation blocked by bug 1183013, though): DONE
[mhall119] Provide development environment setup instructions: DONE
[mhall119] Check with Timo about getting upstream Qt doc output: DONE
Create API template for pre-generated html: DONE

Work items for ubuntu-13.09:
[mhall119] Initialize South for migrations: DONE
[mhall119] Create a WSGI file for running under mod_wsgi: DONE
[mhall119] Get website running under /api/ on developer portal staging site: DONE
[mhall119] Refactor Distro/Release/Platform models to support Juju, Scopes and Webapps APIs: DONE
[mhall119] Provide header-less qdoc configs for easy importing (importer just ignores header and footer instead): DONE
[mhall119] Write QDoc QML import management command: DONE
[mhall119] Replace QDoc link hrefs with API website URL paths: DONE
[mhall119] Write a Juju charm for deploying the site: DONE
[mhall119] Blog about the project and how to get involved: TODO
[mhall119] Add sidenav to match the Wordpress sidenav for each topic: DONE
[mhall119] Provide fixtures to bootstrap database with release data: DONE
[mhall119] Add search functionality: DONE
[mhall119] Figure out something to do with links to Qt page documentation: DONE
Figure out how to include images referenced in Qt docs: TODO
Write Scopes documentation import management command: TODO
Write HTML5 documentation import management command: TODO
Write Cordova documentation import management command: TODO
Write Webapps JS documentation import management command: TODO

Work items:
[mhall119] Integrate with new theme: TODO
Write XML transform for qdoc XML output: POSTPONED
Produce page templates: TODO

Dependency tree

* Blueprints in grey have been implemented.

This blueprint contains Public information 
Everyone can see this information.