Ubuntu UI Toolkit

Merge lp:~nskaggs/ubuntu-ui-toolkit/aphelperdocs-staging into lp:ubuntu-ui-toolkit/staging

aphelperdocs-staging
Merge into staging

Proposed by Nicholas Skaggs on 2015-01-14

Status:

Merged

Approved by:

Tim Peeters on 2015-02-03

Approved revision:

1386

Merged at revision:

1396

Proposed branch:

lp:~nskaggs/ubuntu-ui-toolkit/aphelperdocs-staging

Merge into:

lp:ubuntu-ui-toolkit/staging

Diff against target:

877 lines (+805/-0)

10 files modified

README (+16/-0)
debian/control (+1/-0)
debian/rules (+3/-0)
debian/ubuntu-ui-toolkit-autopilot.docs (+2/-0)
documentation/autopilot-helpers/Makefile (+177/-0)
documentation/autopilot-helpers/_static/nature.css (+211/-0)
documentation/autopilot-helpers/_templates/layout.html (+28/-0)
documentation/autopilot-helpers/conf.py (+340/-0)
documentation/autopilot-helpers/index.rst (+17/-0)
documentation/autopilot-helpers/ubuntuuitoolkit.rst (+10/-0)

To merge this branch:

bzr merge lp:~nskaggs/ubuntu-ui-toolkit/aphelperdocs-staging

Related bugs:

Bug #1409778: autopilot and autopilot sdk helper documentation needs API website integration	Undecided	In Progress
Bug #1410477: ubuntu-ui-toolkit-autopilot documentation is not buildable	Undecided	Fix Released

Link a bug report

Reviewer	Review Type	Date Requested	Status
PS Jenkins bot	continuous-integration		Approve on 2015-02-03
Tim Peeters		2015-01-14	Approve on 2015-02-03
Zoltan Balogh	packaging	2015-01-29	Pending
Leo Arias	autopilot doc coverage	2015-01-26	Pending
Review via email: mp+246439@code.launchpad.net

This proposal supersedes a proposal from 2015-01-13.

Commit message

Re-add autopilot helper documentation and update

Description of the change

Re-add autopilot helper documentation and update. I placed the resulting sphinx documentation in ubuntu-ui-toolkit-autopilot, which is in universe and can safely depend on sphinx. I also added a json build to the docs so they can be integrated into the developer.ubuntu.com API website easily.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-14:

FAILED: Continuous integration, rev:1380
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1362/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/803/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/89/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/92/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/89/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/801/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1362/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2015-01-14:

bah; sphinx isn't a build depends. Perhaps I can't do things this way since we are building ubuntu-ui-toolkit?

lp:~nskaggs/ubuntu-ui-toolkit/aphelperdocs-staging updated on 2015-01-14

1381. By Nicholas Skaggs on 2015-01-14: move sphinx to build-depends

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-14:

FAILED: Continuous integration, rev:1381
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1363/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/805/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/90/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/93/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/90/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/803/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1363/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2015-01-14:

sphinx-build -b singlehtml documentation/autopilot-helpers documentation/autopilot-helpers/_build/html
make[1]: sphinx-build: Command not found.

it seems not.

lp:~nskaggs/ubuntu-ui-toolkit/aphelperdocs-staging updated on 2015-01-23

1382. By Nicholas Skaggs on 2015-01-23: add makefile
1383. By Nicholas Skaggs on 2015-01-23: move build depends back
1384. By Nicholas Skaggs on 2015-01-23: rebase to trunk

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-23:

FAILED: Continuous integration, rev:1384
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1383/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/963/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/110/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/113/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/110/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/961/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1383/rebuild

review: Needs Fixing (continuous-integration)

lp:~nskaggs/ubuntu-ui-toolkit/aphelperdocs-staging updated on 2015-01-26

1385. By Nicholas Skaggs on 2015-01-26: pep8
1386. By Nicholas Skaggs on 2015-01-26: fix for pyflakes

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-26:

FAILED: Continuous integration, rev:1385
http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1384/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-deb-autopilot-vivid-touch/986/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-amd64-ci/111/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-armhf-ci/114/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-vivid-i386-ci/111/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-vivid-armhf/984/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1384/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-26:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1386/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2015-01-26:

This is ready now for proper review. No packaging issues, mainline exceptions or other should remain.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-26:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1387/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2015-01-27:

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/ubuntu-sdk-team-ubuntu-ui-toolkit-staging-ci/1390/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-01-29:

Is Sphinx the common thing we use for all autopilot docs?

review: Needs Information

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-01-29:

Looks good, thanks!

I would like to get a second opinion from Zoltan about the packaging. Perhaps we should include a build target for for the toolkit that generates these docs, and maybe we need to package them as well?

Revision history for this message

Tim Peeters (tpeeters) on 2015-01-29:

review: Approve

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2015-01-29:

Yes, having another package is an option. Something like ubuntu-ui-toolkit-autopilot-docs. However, autopilot itself ships with it's docs as part of the primary package, so I think we can follow their example here.

If you do wish to have another package specifically for this I worry folks won't install it and will miss the documentation.

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2015-01-29:

And yes, sphinx is common for all python projects in general.

Revision history for this message

Nicholas Skaggs (nskaggs) wrote on 2015-02-03:

Per our conversation on IRC Zoltan, I filed a bug to capture your concerns.

https://bugs.launchpad.net/ubuntu/+source/ubuntu-ui-toolkit/+bug/1417718

Revision history for this message

Tim Peeters (tpeeters) wrote on 2015-02-03:

thanks, happroving

review: Approve

Revision history for this message

PS Jenkins bot (ps-jenkins) on 2015-02-03:

review: Approve (continuous-integration)

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk

Subscribers

People subscribed via source and target branches

to all changes:

Dan Chapman 

Nicholas Skaggs

Tom Mirmar

Ubuntu SDK team

 === modified file 'README'
 --- README	2014-03-17 08:53:32 +0000
 +++ README	2015-01-26 16:22:53 +0000
@@ -50,3 +50,19 @@
  Once built, you may view the documentation by opening
    documentation/html/overview-ubuntu-sdk.html
  in your favorite web browser.
++
++Autopilot SDK Helpers Documentation (Sphinx docs):
++++++++++++++++++++++++++++++++++++++++++++++++++++
++
++To build the Autopilot SDK Helpers documentation, you need to install sphinx.
++After installation, change directory to documentation/autopilot-helpers
++and executing make.
++
++ * $ sudo apt-get install python3-sphinx
++
++ * $ cd documentation/autopilot-helpers
++
++ * $ make singlehtml
++
++ * Once built, you may view the documentation by opening
++ `_build/singlehtml/index.html` in your favorite web browser.
 === modified file 'debian/control'
 --- debian/control	2015-01-19 08:50:05 +0000
 +++ debian/control	2015-01-26 16:22:53 +0000
@@ -45,6 +45,7 @@
                 locales,
                 suru-icon-theme,
                 uuid-runtime,
++               python3-sphinx,
  Standards-Version: 3.9.4
  Homepage: https://launchpad.net/ubuntu-ui-toolkit
  # If you aren't a member of ~ubuntu-sdk-team but need to upload packaging
 === modified file 'debian/rules'
 --- debian/rules	2014-11-27 14:36:38 +0000
 +++ debian/rules	2015-01-26 16:22:53 +0000
@@ -34,6 +34,9 @@
  	dh_auto_build --parallel -- docs
  override_dh_install:
++	dh_auto_build -- docs
++	sphinx-build -b singlehtml documentation/autopilot-helpers documentation/autopilot-helpers/_build/html
++	sphinx-build -b json documentation/autopilot-helpers documentation/autopilot-helpers/_build/json
  	mkdir -p debian/tmp/`qmake -query QT_INSTALL_DOCS`/qch
  	mkdir -p debian/tmp/usr/share/ubuntu-ui-toolkit/doc
  	cp -r $(CURDIR)/documentation/*qch debian/tmp/`qmake -query QT_INSTALL_DOCS`/qch
 === added file 'debian/ubuntu-ui-toolkit-autopilot.docs'
 --- debian/ubuntu-ui-toolkit-autopilot.docs	1970-01-01 00:00:00 +0000
 +++ debian/ubuntu-ui-toolkit-autopilot.docs	2015-01-26 16:22:53 +0000
@@ -0,0 +1,2 @@
++documentation/autopilot-helpers/_build/html
++documentation/autopilot-helpers/_build/json
 === added directory 'documentation/autopilot-helpers'
 === added file 'documentation/autopilot-helpers/Makefile'
 --- documentation/autopilot-helpers/Makefile	1970-01-01 00:00:00 +0000
 +++ documentation/autopilot-helpers/Makefile	2015-01-26 16:22:53 +0000
@@ -0,0 +1,177 @@
++# Makefile for Sphinx documentation
++#
++
++# You can set these variables from the command line.
++SPHINXOPTS    =
++SPHINXBUILD   = sphinx-build
++PAPER         =
++BUILDDIR      = _build
++
++# User-friendly check for sphinx-build
++ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
++$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
++endif
++
++# Internal variables.
++PAPEROPT_a4     = -D latex_paper_size=a4
++PAPEROPT_letter = -D latex_paper_size=letter
++ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
++# the i18n builder cannot share the environment and doctrees with the others
++I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
++
++.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
++
++help:
++	@echo "Please use \`make <target>' where <target> is one of"
++	@echo "  html       to make standalone HTML files"
++	@echo "  dirhtml    to make HTML files named index.html in directories"
++	@echo "  singlehtml to make a single large HTML file"
++	@echo "  pickle     to make pickle files"
++	@echo "  json       to make JSON files"
++	@echo "  htmlhelp   to make HTML files and a HTML help project"
++	@echo "  qthelp     to make HTML files and a qthelp project"
++	@echo "  devhelp    to make HTML files and a Devhelp project"
++	@echo "  epub       to make an epub"
++	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
++	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
++	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
++	@echo "  text       to make text files"
++	@echo "  man        to make manual pages"
++	@echo "  texinfo    to make Texinfo files"
++	@echo "  info       to make Texinfo files and run them through makeinfo"
++	@echo "  gettext    to make PO message catalogs"
++	@echo "  changes    to make an overview of all changed/added/deprecated items"
++	@echo "  xml        to make Docutils-native XML files"
++	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
++	@echo "  linkcheck  to check all external links for integrity"
++	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
++
++clean:
++	rm -rf $(BUILDDIR)/*
++
++html:
++	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
++	@echo
++	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
++
++dirhtml:
++	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
++	@echo
++	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
++
++singlehtml:
++	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
++	@echo
++	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
++
++pickle:
++	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
++	@echo
++	@echo "Build finished; now you can process the pickle files."
++
++json:
++	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
++	@echo
++	@echo "Build finished; now you can process the JSON files."
++
++htmlhelp:
++	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
++	@echo
++	@echo "Build finished; now you can run HTML Help Workshop with the" \
++	      ".hhp project file in $(BUILDDIR)/htmlhelp."
++
++qthelp:
++	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
++	@echo
++	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
++	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
++	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sdkhelpers.qhcp"
++	@echo "To view the help file:"
++	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sdkhelpers.qhc"
++
++devhelp:
++	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
++	@echo
++	@echo "Build finished."
++	@echo "To view the help file:"
++	@echo "# mkdir -p $$HOME/.local/share/devhelp/sdkhelpers"
++	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sdkhelpers"
++	@echo "# devhelp"
++
++epub:
++	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
++	@echo
++	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
++
++latex:
++	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
++	@echo
++	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
++	@echo "Run \`make' in that directory to run these through (pdf)latex" \
++	      "(use \`make latexpdf' here to do that automatically)."
++
++latexpdf:
++	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
++	@echo "Running LaTeX files through pdflatex..."
++	$(MAKE) -C $(BUILDDIR)/latex all-pdf
++	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
++
++latexpdfja:
++	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
++	@echo "Running LaTeX files through platex and dvipdfmx..."
++	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
++	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
++
++text:
++	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
++	@echo
++	@echo "Build finished. The text files are in $(BUILDDIR)/text."
++
++man:
++	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
++	@echo
++	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
++
++texinfo:
++	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
++	@echo
++	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
++	@echo "Run \`make' in that directory to run these through makeinfo" \
++	      "(use \`make info' here to do that automatically)."
++
++info:
++	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
++	@echo "Running Texinfo files through makeinfo..."
++	make -C $(BUILDDIR)/texinfo info
++	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
++
++gettext:
++	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
++	@echo
++	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
++
++changes:
++	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
++	@echo
++	@echo "The overview file is in $(BUILDDIR)/changes."
++
++linkcheck:
++	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
++	@echo
++	@echo "Link check complete; look for any errors in the above output " \
++	      "or in $(BUILDDIR)/linkcheck/output.txt."
++
++doctest:
++	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
++	@echo "Testing of doctests in the sources finished, look at the " \
++	      "results in $(BUILDDIR)/doctest/output.txt."
++
++xml:
++	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
++	@echo
++	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
++
++pseudoxml:
++	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
++	@echo
++	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
 === added directory 'documentation/autopilot-helpers/_static'
 === added file 'documentation/autopilot-helpers/_static/favicon.ico'
 Binary files documentation/autopilot-helpers/_static/favicon.ico	1970-01-01 00:00:00 +0000 and documentation/autopilot-helpers/_static/favicon.ico	2015-01-26 16:22:53 +0000 differ
 === added file 'documentation/autopilot-helpers/_static/nature.css'
 --- documentation/autopilot-helpers/_static/nature.css	1970-01-01 00:00:00 +0000
 +++ documentation/autopilot-helpers/_static/nature.css	2015-01-26 16:22:53 +0000
@@ -0,0 +1,211 @@
++/*
++    Copyright 2015 Canonical Ltd.
++*/
++
++ @import url(basic.css);
++
++body {
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++    font-size:100%;
++    background-color:#2C001E;
++    margin:0;
++    padding:0;
++    }
++
++div.documentwrapper {
++    float:left;
++    width:100%;
++}
++
++div.bodywrapper {
++    margin:0 0 0 0;
++}
++
++hr {
++    border:1px solid #B1B4B6;
++}
++
++div.body {
++    background-color:#FFF;
++    color:#3E4349;
++    font-size:.9em;
++    padding:0 30px 30px;
++}
++
++div.footer {
++    color:#CCC;
++    width:100%;
++    text-align:center;
++    font-size:75%;
++    padding:13px 0;
++}
++
++div.footer a {
++    color:#444;
++    text-decoration:underline;
++}
++
++div.related {
++    background-color:#DD4814;
++    line-height:32px;
++    color:#fff;
++    font-size:.9em;
++}
++
++div.related a {
++    color:#EEE;
++}
++
++div.sphinxsidebar {
++    font-size:.75em;
++    line-height:1.5em;
++}
++
++div.sphinxsidebarwrapper {
++    padding:20px 0;
++}
++
++div.sphinxsidebar h3,
++div.sphinxsidebar h4 {
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++    color:#222;
++    font-size:1.2em;
++    font-weight:400;
++    background-color:#ddd;
++    margin:0;
++    padding:5px 10px;
++}
++
++div.sphinxsidebar p {
++    color:#444;
++    padding:2px 10px;
++}
++
++div.sphinxsidebar ul {
++    color:#000;
++    margin:10px 5px;
++    padding:0;
++}
++
++div.sphinxsidebar input {
++    border:1px solid #ccc;
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++    font-size:1em;
++}
++
++div.sphinxsidebar input[type=text] {
++    margin-left:5px;
++}
++
++a {
++    color:#5E2750;
++    text-decoration:none;
++}
++
++a:hover {
++    color:#DD4814;
++    text-decoration:underline;
++}
++
++div.body h1 {
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++    font-weight:bold;
++    font-size:200%;
++    color:#444;
++    margin:20px 0 10px;
++    padding:5px 0 5px 10px;
++}
++
++div.body h2 {
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++    font-size:130%;
++    background-color:#CCC;
++    margin:20px 0 10px;
++    padding:5px 0 5px 10px;
++}
++
++div.body h6 {
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++    background-color:#BED4EB;
++    font-weight:400;
++    color:#333;
++    margin:30px 0 10px;
++    padding:5px 0 5px 10px;
++}
++
++a.headerlink {
++    text-decoration:none;
++    padding:0 4px;
++}
++
++a.headerlink:hover {
++    background-color:#AEA79F;
++    color:#FFF;
++}
++
++div.body p,div.body dd,div.body li {
++    line-height:1.5em;
++}
++
++div.highlight {
++    background-color:#FFF;
++}
++
++div.note {
++    background-color:#eee;
++    border:1px solid #ccc;
++}
++
++div.seealso {
++    background-color:#ffc;
++    border:1px solid #ff6;
++}
++
++div.warning {
++    background-color:#ffe4e4;
++    border:1px solid #f66;
++}
++
++p.admonition-title:after {
++    content:":";
++}
++
++pre {
++    background-color:#EFEFEF;
++    color:#000;
++    line-height:1.1em;
++    border:1px solid #C6C9CB;
++    font-size:1.2em;
++    font-family:"Ubuntu Mono", Monaco, Consolas, "DejaVu Sans Mono", "Lucida Console", monospace;
++    margin:1.5em 0;
++    padding:6px;
++}
++
++tt {
++    background-color:#EFEFEF;
++    color:#222;
++    font-size:1.1em;
++    font-family:"Ubuntu Mono", Monaco, Consolas, "DejaVu Sans Mono", "Lucida Console", monospace;
++}
++
++.viewcode-back {
++    font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
++}
++
++div.viewcode-block:target {
++    background-color:#f4debf;
++    border-top:1px solid #ac9;
++    border-bottom:1px solid #ac9;
++}
++
++div.document,div.topic {
++ background-color:#eee;
++}
++
++div.sphinxsidebar h3 a,div.sphinxsidebar a {
++ color:#444;
++}
++
++div.admonition p.admonition-title + p,p.admonition-title {
++    display:inline;
++}
 === added directory 'documentation/autopilot-helpers/_templates'
 === added file 'documentation/autopilot-helpers/_templates/layout.html'
 --- documentation/autopilot-helpers/_templates/layout.html	1970-01-01 00:00:00 +0000
 +++ documentation/autopilot-helpers/_templates/layout.html	2015-01-26 16:22:53 +0000
@@ -0,0 +1,28 @@
++<!--
++    Copyright 2015 Canonical Ltd.
++-->
++
++{#
++    default/layout.html
++    ~~~~~~~~~~~~~~~~~~~
++
++    Sphinx layout template for the default theme.
++
++    :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
++    :license: BSD, see LICENSE for details.
++#}
++{% extends "basic/layout.html" %}
++
++{%- block content %}
++<div class="document">
++  {%- block document %}
++      <div class="documentwrapper">
++      {%- if render_sidebar %}
++        <div class="bodywrapper">
++      {%- endif %}
++          <div class="body">
++            {% block body %} {% endblock %}
++          </div>
++      </div>
++  {%- endblock %}
++{%- endblock %}
 === added file 'documentation/autopilot-helpers/conf.py'
 --- documentation/autopilot-helpers/conf.py	1970-01-01 00:00:00 +0000
 +++ documentation/autopilot-helpers/conf.py	2015-01-26 16:22:53 +0000
@@ -0,0 +1,340 @@
++# -*- coding: utf-8 -*-
++#
++# ubuntu-ui-toolkit-autopilot documentation build configuration file.
++#
++# This file is execfile()d with the current directory set to its
++# containing dir.
++#
++# Note that not all possible configuration values are present in this
++# autogenerated file.
++#
++# All configuration values have a default; values that are commented out
++# serve to show the default.
++
++import sys
++assert sys
++import os
++assert os
++
++# If extensions (or modules to document with autodoc) are in another directory,
++# add these directories to sys.path here. If the directory is relative to the
++# documentation root, use os.path.abspath to make it absolute, like shown here.
++# sys.path.insert(0, os.path.abspath('.'))
++
++# -- General configuration ------------------------------------------------
++
++# If your documentation needs a minimal Sphinx version, state it here.
++# needs_sphinx = '1.0'
++
++# Add any Sphinx extension module names here, as strings. They can be
++# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
++# ones.
++extensions = [
++    'sphinx.ext.autodoc',
++    'sphinx.ext.doctest',
++    'sphinx.ext.todo',
++    'sphinx.ext.viewcode',
++]
++
++# Add any paths that contain templates here, relative to this directory.
++templates_path = ['_templates']
++
++# The suffix of source filenames.
++source_suffix = '.rst'
++
++# The encoding of source files.
++# source_encoding = 'utf-8-sig'
++
++# The master toctree document.
++master_doc = 'index'
++
++# General information about the project.
++project = u'ubuntu-ui-toolkit-autopilot'
++copyright = u'2015, Canonical'
++
++# The version info for the project you're documenting, acts as replacement for
++# |version| and |release|, also used in various other places throughout the
++# built documents.
++#
++# The short X.Y version.
++version = '15.04'
++# The full version, including alpha/beta/rc tags.
++release = '15.04'
++
++# The language for content autogenerated by Sphinx. Refer to documentation
++# for a list of supported languages.
++# language = None
++
++# There are two options for replacing |today|: either, you set today to some
++# non-false value, then it is used:
++# today = ''
++# Else, today_fmt is used as the format for a strftime call.
++# today_fmt = '%B %d, %Y'
++
++# List of patterns, relative to source directory, that match files and
++# directories to ignore when looking for source files.
++exclude_patterns = ['_build']
++
++# The reST default role (used for this markup: `text`) to use for all
++# documents.
++# default_role = None
++
++# If true, '()' will be appended to :func: etc. cross-reference text.
++# add_function_parentheses = True
++
++# If true, the current module name will be prepended to all description
++# unit titles (such as .. function::).
++# add_module_names = True
++
++# If true, sectionauthor and moduleauthor directives will be shown in the
++# output. They are ignored by default.
++# show_authors = False
++
++# The name of the Pygments (syntax highlighting) style to use.
++pygments_style = 'sphinx'
++
++# A list of ignored prefixes for module index sorting.
++# modindex_common_prefix = []
++
++# If true, keep warnings as "system message" paragraphs in the built documents.
++# keep_warnings = False
++
++
++# -- Options for HTML output ----------------------------------------------
++
++# The theme to use for HTML and HTML Help pages.  See the documentation for
++# a list of builtin themes.
++html_theme = 'default'
++
++# Theme options are theme-specific and customize the look and feel of a theme
++# further.  For a list of options available for each theme, see the
++# documentation.
++# html_theme_options = {}
++
++# Add any paths that contain custom themes here, relative to this directory.
++# html_theme_path = []
++
++# The name for this set of Sphinx documents.  If None, it defaults to
++# "<project> v<release> documentation".
++# html_title = None
++
++# A shorter title for the navigation bar.  Default is the same as html_title.
++# html_short_title = None
++
++# The name of an image file (relative to this directory) to place at the top
++# of the sidebar.
++# html_logo = None
++
++html_favicon = './images/favicon.ico'
++
++# Add any paths that contain custom static files (such as style sheets) here,
++# relative to this directory. They are copied after the builtin static files,
++# so a file named "default.css" will overwrite the builtin "default.css".
++html_static_path = ['_static']
++
++# Add any extra paths that contain custom files (such as robots.txt or
++# .htaccess) here, relative to this directory. These files are copied
++# directly to the root of the documentation.
++# html_extra_path = []
++
++# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
++# using the given strftime format.
++# html_last_updated_fmt = '%b %d, %Y'
++
++# If true, SmartyPants will be used to convert quotes and dashes to
++# typographically correct entities.
++# html_use_smartypants = True
++
++# Custom sidebar templates, maps document names to template names.
++# html_sidebars = {}
++
++html_domain_indices = True
++# Additional templates that should be rendered to pages, maps page names to
++# template names.
++html_use_index = True
++# html_additional_pages = {}
++
++# If false, no module index is generated.
++# html_domain_indices = True
++
++html_show_sourcelink = False
++# If false, no index is generated.
++# html_use_index = True
++html_show_sphinx = False
++
++# If true, the index is split into individual pages for each letter.
++html_show_copyright = True
++# html_split_index = False
++
++# If true, links to the reST sources are added to the pages.
++# html_show_sourcelink = True
++
++# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
++# html_show_sphinx = True
++
++# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
++# html_show_copyright = True
++
++# If true, an OpenSearch description file will be output, and all pages will
++# contain a <link> tag referring to it.  The value of this option must be the
++# base URL from which the finished HTML is served.
++# html_use_opensearch = ''
++
++# This is the file name suffix for HTML files (e.g. ".xhtml").
++# html_file_suffix = None
++
++# Output file base name for HTML help builder.
++htmlhelp_basename = 'ubuntu-ui-toolkit-autopilotdoc'
++
++
++# -- Options for LaTeX output ---------------------------------------------
++
++latex_elements = {
++    # The paper size ('letterpaper' or 'a4paper').
++    # 'papersize': 'letterpaper',
++
++    # The font size ('10pt', '11pt' or '12pt').
++    # 'pointsize': '10pt',
++
++    # Additional stuff for the LaTeX preamble.
++    # 'preamble': '',
++}
++
++# Grouping the document tree into LaTeX files. List of tuples
++# (source start file, target name, title,
++#  author, documentclass [howto, manual, or own class]).
++latex_documents = [
++    ('index', 'ubuntu-ui-toolkit-autopilot.tex',
++     u'ubuntu-ui-toolkit-autopilot Documentation',
++     u'authors', 'manual'),
++]
++
++# The name of an image file (relative to this directory) to place at the top of
++# the title page.
++# latex_logo = None
++
++# For "manual" documents, if this is true, then toplevel headings are parts,
++# not chapters.
++# latex_use_parts = False
++
++# If true, show page references after internal links.
++# latex_show_pagerefs = False
++
++# If true, show URL addresses after external links.
++# latex_show_urls = False
++
++# Documents to append as an appendix to all manuals.
++# latex_appendices = []
++
++# If false, no module index is generated.
++# latex_domain_indices = True
++
++
++# -- Options for manual page output ---------------------------------------
++
++# One entry per manual page. List of tuples
++# (source start file, name, description, authors, manual section).
++man_pages = [
++    ('index', 'ubuntu-ui-toolkit-autopilot',
++     u'ubuntu-ui-toolkit-autopilot Documentation',
++     [u'authors'], 1)
++]
++
++# If true, show URL addresses after external links.
++# man_show_urls = False
++
++
++# -- Options for Texinfo output -------------------------------------------
++
++# Grouping the document tree into Texinfo files. List of tuples
++# (source start file, target name, title, author,
++#  dir menu entry, description, category)
++texinfo_documents = [
++    ('index', 'ubuntu-ui-toolkit-autopilot',
++     u'ubuntu-ui-toolkit-autopilot Documentation',
++     u'authors', 'ubuntu-ui-toolkit-autopilot',
++     'An autopilot emulator for the ubuntu sdk',
++     'Miscellaneous'),
++]
++
++# Documents to append as an appendix to all manuals.
++# texinfo_appendices = []
++
++# If false, no module index is generated.
++# texinfo_domain_indices = True
++
++# How to display URL addresses: 'footnote', 'no', or 'inline'.
++# texinfo_show_urls = 'footnote'
++
++# If true, do not generate a @detailmenu in the "Top" node's menu.
++# texinfo_no_detailmenu = False
++
++
++# -- Options for Epub output ----------------------------------------------
++
++# Bibliographic Dublin Core info.
++epub_title = u'ubuntu-ui-toolkit-autopilot'
++epub_author = u'authors'
++epub_publisher = u'Canonical'
++epub_copyright = u'2015, Canonical'
++
++# The basename for the epub file. It defaults to the project name.
++# epub_basename = u'ubuntu-ui-toolkit-autopilot'
++
++# The HTML theme for the epub output. Since the default themes are not
++# optimized for small screen space, using the same theme for HTML and
++# epub output is usually not wise. This defaults to 'epub', a theme
++# designed to save visual space.
++# epub_theme = 'epub'
++
++# The language of the text. It defaults to the language option
++# or en if the language is not set.
++# epub_language = ''
++
++# The scheme of the identifier. Typical schemes are ISBN or URL.
++# epub_scheme = ''
++
++# The unique identifier of the text. This can be a ISBN number
++# or the project homepage.
++# epub_identifier = ''
++
++# A unique identification for the text.
++# epub_uid = ''
++
++# A tuple containing the cover image and cover page html template filenames.
++# epub_cover = ()
++
++# A sequence of (type, uri, title) tuples for the guide element of content.opf.
++# epub_guide = ()
++
++# HTML files that should be inserted before the pages created by sphinx.
++# The format is a list of tuples containing the path and title.
++# epub_pre_files = []
++
++# HTML files shat should be inserted after the pages created by sphinx.
++# The format is a list of tuples containing the path and title.
++# epub_post_files = []
++
++# A list of files that should not be packed into the epub file.
++epub_exclude_files = ['search.html']
++
++# The depth of the table of contents in toc.ncx.
++# epub_tocdepth = 3
++
++# Allow duplicate toc entries.
++# epub_tocdup = True
++
++# Choose between 'default' and 'includehidden'.
++# epub_tocscope = 'default'
++
++# Fix unsupported image types using the PIL.
++# epub_fix_images = False
++
++# Scale large images.
++# epub_max_image_width = 0
++
++# How to display URL addresses: 'footnote', 'no', or 'inline'.
++# epub_show_urls = 'inline'
++
++# If false, no index is generated.
++# epub_use_index = True
 === added directory 'documentation/autopilot-helpers/images'
 === added file 'documentation/autopilot-helpers/images/favicon.ico'
 Binary files documentation/autopilot-helpers/images/favicon.ico	1970-01-01 00:00:00 +0000 and documentation/autopilot-helpers/images/favicon.ico	2015-01-26 16:22:53 +0000 differ
 === added file 'documentation/autopilot-helpers/index.rst'
 --- documentation/autopilot-helpers/index.rst	1970-01-01 00:00:00 +0000
 +++ documentation/autopilot-helpers/index.rst	2015-01-26 16:22:53 +0000
@@ -0,0 +1,17 @@
++.. ubuntu-ui-toolkit-autopilot documentation master file, created by
++   sphinx-quickstart on Thu Jan  8 12:39:43 2015.
++   You can adapt this file completely to your liking, but it should at least
++   contain the root `toctree` directive.
++
++Welcome to ubuntu-ui-toolkit-autopilot's documentation!
++======================================
++
++Contents:
++
++.. toctree::
++   :maxdepth: 2
++
++   ubuntuuitoolkit
++
++* :ref:`genindex`
++
 === added file 'documentation/autopilot-helpers/ubuntuuitoolkit.rst'
 --- documentation/autopilot-helpers/ubuntuuitoolkit.rst	1970-01-01 00:00:00 +0000
 +++ documentation/autopilot-helpers/ubuntuuitoolkit.rst	2015-01-26 16:22:53 +0000
@@ -0,0 +1,10 @@
++ubuntuuitoolkit Package
++=======================
++
++:mod:`custom proxy object` Module
++---------------------------------
++
++.. automodule:: ubuntuuitoolkit
++    :members:
++    :undoc-members:
++    :show-inheritance: