Merge lp:~nskaggs/ubuntu-ui-toolkit/emulator-docs-try3 into lp:ubuntu-ui-toolkit

Proposed by Nicholas Skaggs
Status: Merged
Approved by: Cris Dywan
Approved revision: 901
Merged at revision: 951
Proposed branch: lp:~nskaggs/ubuntu-ui-toolkit/emulator-docs-try3
Merge into: lp:ubuntu-ui-toolkit
Diff against target: 681 lines (+598/-5)
10 files modified
README (+22/-2)
debian/changelog (+6/-0)
debian/control (+4/-2)
debian/rules (+3/-1)
debian/ubuntu-ui-toolkit-autopilot.docs (+1/-0)
docs-autopilot-emulator/_static/nature.css (+211/-0)
docs-autopilot-emulator/_templates/layout.html (+28/-0)
docs-autopilot-emulator/conf.py (+290/-0)
docs-autopilot-emulator/index.rst (+23/-0)
docs-autopilot-emulator/ubuntuuitoolkit.rst (+10/-0)
To merge this branch: bzr merge lp:~nskaggs/ubuntu-ui-toolkit/emulator-docs-try3
Reviewer Review Type Date Requested Status
Cris Dywan Approve
PS Jenkins bot continuous-integration Approve
Review via email: mp+199353@code.launchpad.net

This proposal supersedes a proposal from 2013-10-29.

Commit message

Add docs for ubuntu UITK autopilot emulator

Description of the change

To post a comment you must log in.
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote : Posted in a previous version of this proposal
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote : Posted in a previous version of this proposal
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote : Posted in a previous version of this proposal
review: Needs Fixing (continuous-integration)
Revision history for this message
Cris Dywan (kalikiana) wrote : Posted in a previous version of this proposal

This is missing a dependency:

=== modified file 'debian/control'
--- debian/control 2013-11-22 20:06:11 +0000
+++ debian/control 2013-11-27 09:41:30 +0000
@@ -7,6 +7,7 @@ Build-Depends: debhelper (>= 9.0.0),
                libgles2-mesa-dev,
                libglib2.0-dev,
                python,
+ python-sphinx,
                libqt5qml-graphicaleffects | libqt5graphicaleffects5,
                qt5-default,
                qtbase5-dev,

review: Needs Fixing
Revision history for this message
Cris Dywan (kalikiana) wrote : Posted in a previous version of this proposal

I also get a bunch of warnings by "pep8 docs-autopilot-emulator/conf.py" which Jenkins will complain about.

review: Needs Fixing
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote : Posted in a previous version of this proposal
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
Nicholas Skaggs (nskaggs) wrote :

Ok so,

sphinx-build -b html docs-autopilot-emulator emulator-html
make[1]: sphinx-build: Command not found

I wonder if this depends needs to be more top-level.

895. By Nicholas Skaggs

force rebuild

896. By Nicholas Skaggs

Rebase to trunk
[ Zsombor Egri ]
* Layouting fails with Qt5.2 if the tests and components are not
  rendered upon testing. Layout unit tests have been transferred to
  X11 unit tests and tests on layout changes all wait till the layout
  change completes. Tested with Qt 5.0.2 and Qt 5.2 RC1. (LP:
  #1256235)
* Picker visuals facelift, prepared for Date- and TimePicker
  components.
* Picker selectedIndex miss-behavior fix when model is
  cleared/cropped/reset.
[ Florian Boucault ]
* List item progression: use appropriate icon (same as Tabs' arrow)
  and fixes the issue of it being the wrong color in Dark and Gradient
  themes. (LP: #1236777)
[ Albert Astals ]
* tst_arguments: Do not use QTEST_MAIN QTEST_MAIN is 99.99% of the
  times what you want when running a Qt testcase but it creates a
  Q*Application and in this case that is not wanted since we are
  creating and destroying them as part of the test and Qt doesn't like
  when there's more than one Q*Application at the same time, so do
  without creating a Q*Application in main. This can of course have
  some implications but it seems that for this testcase all is fine.
  (LP: #1254747)
* Make the model a var and not a ListModel ListModel is bound
  specifically to QQuickListModel By using a var we can use other
  QAbstractItemModel subclasses in the model.
[ Nic ]
* Removed stop animation on text every time an expansion/collapse is
  made. Fixes bug #1231939. (LP: #1231939)
* Fixed scrolling in selector when parent widget's height is less than
  the selector's ListView height. Fixes bug #1256356. (LP: #1256356)
[ Timo Jyrinki ]
* Require either Qt 5.2 or libqt5v8-5-private-dev.
[ tpeeters ]
* Reset hide timer when user interacts with toolbar or toolbar
  buttons. (LP: #1249031)
* Improve detection of tab bar interaction. Now using the new
  TabBar.pressed property instead of TabBar.selectionMode property,
  because selectionMode may be changed without user interaction (for
  example, when resuming an app in a following MR), and then the
  toolbar should not automatically hide.
* Open the toolbar and tabbar (without animating) when the app is
  resumed. (LP: #1246790)
[ Christian Dywan ]
* Accept qmldir files in qmlapicheck and skip internal components.
  (LP: #1256045)
* Suppress qdoc warnings coming from upstream API.
* Conditionally define doc folder containing resources. (LP: #1256779)
* Move doc commands to shellscript and add success output lines.
* Use Eventually when checking that the textfield is empty There's
  always a delay so we can't just compare it. (LP: #1259476)
[ Ubuntu daily release ]
* Automatic snapshot from revision 892

897. By Nicholas Skaggs

fix build depends

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
Cris Dywan (kalikiana) wrote :

I don't see the docs anywhere with the .deb installed, doesn't look like emulator-html is installed anywhere.

review: Needs Fixing
898. By Nicholas Skaggs

add docs to deb package

Revision history for this message
Nicholas Skaggs (nskaggs) wrote :

Thanks Christian. I added it so it should install now in /usr/docs/ubuntu-ui-toolkit-autopilot/html

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
Cris Dywan (kalikiana) wrote :

I got /usr/share/doc/ubuntu-ui-toolkit-autopilot/html/index.html and it lists "emulators Module" except that's empty.

review: Needs Information
899. By Nicholas Skaggs

switch doc build to docs-autopilot-emulator directory

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
Nicholas Skaggs (nskaggs) wrote :

The generated deb still has nothing but the index file in the docs. It builds just fine locally :-(

900. By Nicholas Skaggs

add autopilot to build

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Needs Fixing (continuous-integration)
901. By Nicholas Skaggs

rebuild jenkins

Revision history for this message
Nicholas Skaggs (nskaggs) wrote :

Christian, this should work fine. The armhf build doesn't seem to build properly, but it shouldn't be an issue when it goes to distro. Martin and Jean-Baptiste have both successfully built it locally with sbuild and compared it to the jenkins build, which looks good.

Revision history for this message
PS Jenkins bot (ps-jenkins) wrote :
review: Approve (continuous-integration)
Revision history for this message
Cris Dywan (kalikiana) wrote :

Nice! Thanks for the build fixes.

review: Approve
Revision history for this message
Cris Dywan (kalikiana) wrote :

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1=== modified file 'README'
2--- README 2013-04-24 17:09:29 +0000
3+++ README 2014-02-18 20:17:53 +0000
4@@ -47,6 +47,26 @@
5 Documentation
6 -------------
7
8+Main Documentation (QDocs):
9++++++++++++++++++++++++++++
10+
11 Once built, you may view the documentation by opening
12- documentation/html/overview-ubuntu-sdk.html
13-in your favorite web browser.
14+`documentation/html/overview-ubuntu-sdk.html` in your favorite web browser.
15+
16+
17+Autopilot Emulators (Sphinx docs):
18+++++++++++++++++++++++++++++++++++
19+
20+To build the AutoPilot Emulators API documentation (html),
21+
22+ * install python-sphinx::
23+
24+ $ sudo apt-get install python-sphinx
25+
26+ * from the branch's root, run::
27+
28+ $ sphinx-build -b html docs-autopilot-emulator emulator-html
29+
30+ * Once built, you may view the documentation by opening
31+ `emulator-html/ubuntuuitoolkit.html` in your favorite web browser.
32+
33
34=== modified file 'debian/changelog'
35--- debian/changelog 2014-02-12 10:56:52 +0000
36+++ debian/changelog 2014-02-18 20:17:53 +0000
37@@ -434,6 +434,12 @@
38
39 -- Ubuntu daily release <ps-jenkins@lists.canonical.com> Tue, 05 Nov 2013 16:51:13 +0000
40
41+ubuntu-ui-toolkit (0.1.46+13.10.20131011.2-0ubuntu2) UNRELEASED; urgency=low
42+
43+ * add sphinx documentation
44+
45+ -- Nicholas Skaggs <nicholas.skaggs@canonical.com> Tue, 29 Oct 2013 17:28:30 -0400
46+
47 ubuntu-ui-toolkit (0.1.46+13.10.20131011.2-0ubuntu1) saucy; urgency=low
48
49 [ Zsombor Egri ]
50
51=== modified file 'debian/control'
52--- debian/control 2014-01-30 13:37:10 +0000
53+++ debian/control 2014-02-18 20:17:53 +0000
54@@ -38,10 +38,12 @@
55 xvfb,
56 libgl1-mesa-dri,
57 locales,
58+ python-sphinx,
59+ python-autopilot (>= 1.4),
60 Standards-Version: 3.9.4
61 Homepage: https://launchpad.net/ubuntu-ui-toolkit
62-# If you aren't a member of ~ubuntu-sdk-team but need to upload packaging
63-# changes, just go ahead. ~ubuntu-sdk-team will notice and sync up the code
64+# If you aren't a member of ~ubuntu-sdk-team but need to upload packaging
65+# changes, just go ahead. ~ubuntu-sdk-team will notice and sync up the code
66 # again.
67 Vcs-Bzr: https://code.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/trunk
68
69
70=== modified file 'debian/rules'
71--- debian/rules 2013-12-18 15:54:38 +0000
72+++ debian/rules 2014-02-18 20:17:53 +0000
73@@ -17,6 +17,8 @@
74 dh_auto_build -- docs
75
76 override_dh_install:
77- mkdir -p debian/tmp/`qmake -query QT_INSTALL_DOCS`/qch
78+ dh_auto_build -- docs
79+ sphinx-build -b html docs-autopilot-emulator docs-autopilot-emulator/_build/html
80+ mkdir -p debian/tmp/`qmake -query QT_INSTALL_DOCS`/qch
81 dh_install --fail-missing
82
83
84=== added file 'debian/ubuntu-ui-toolkit-autopilot.docs'
85--- debian/ubuntu-ui-toolkit-autopilot.docs 1970-01-01 00:00:00 +0000
86+++ debian/ubuntu-ui-toolkit-autopilot.docs 2014-02-18 20:17:53 +0000
87@@ -0,0 +1,1 @@
88+docs-autopilot-emulator/_build/html
89
90=== added directory 'docs-autopilot-emulator'
91=== added directory 'docs-autopilot-emulator/_static'
92=== added file 'docs-autopilot-emulator/_static/favicon.ico'
93Binary files docs-autopilot-emulator/_static/favicon.ico 1970-01-01 00:00:00 +0000 and docs-autopilot-emulator/_static/favicon.ico 2014-02-18 20:17:53 +0000 differ
94=== added file 'docs-autopilot-emulator/_static/nature.css'
95--- docs-autopilot-emulator/_static/nature.css 1970-01-01 00:00:00 +0000
96+++ docs-autopilot-emulator/_static/nature.css 2014-02-18 20:17:53 +0000
97@@ -0,0 +1,211 @@
98+/*
99+ Copyright 2013 Canonical Ltd.
100+*/
101+
102+ @import url(basic.css);
103+
104+body {
105+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
106+ font-size:100%;
107+ background-color:#2C001E;
108+ margin:0;
109+ padding:0;
110+ }
111+
112+div.documentwrapper {
113+ float:left;
114+ width:100%;
115+}
116+
117+div.bodywrapper {
118+ margin:0 0 0 0;
119+}
120+
121+hr {
122+ border:1px solid #B1B4B6;
123+}
124+
125+div.body {
126+ background-color:#FFF;
127+ color:#3E4349;
128+ font-size:.9em;
129+ padding:0 30px 30px;
130+}
131+
132+div.footer {
133+ color:#CCC;
134+ width:100%;
135+ text-align:center;
136+ font-size:75%;
137+ padding:13px 0;
138+}
139+
140+div.footer a {
141+ color:#444;
142+ text-decoration:underline;
143+}
144+
145+div.related {
146+ background-color:#DD4814;
147+ line-height:32px;
148+ color:#fff;
149+ font-size:.9em;
150+}
151+
152+div.related a {
153+ color:#EEE;
154+}
155+
156+div.sphinxsidebar {
157+ font-size:.75em;
158+ line-height:1.5em;
159+}
160+
161+div.sphinxsidebarwrapper {
162+ padding:20px 0;
163+}
164+
165+div.sphinxsidebar h3,
166+div.sphinxsidebar h4 {
167+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
168+ color:#222;
169+ font-size:1.2em;
170+ font-weight:400;
171+ background-color:#ddd;
172+ margin:0;
173+ padding:5px 10px;
174+}
175+
176+div.sphinxsidebar p {
177+ color:#444;
178+ padding:2px 10px;
179+}
180+
181+div.sphinxsidebar ul {
182+ color:#000;
183+ margin:10px 5px;
184+ padding:0;
185+}
186+
187+div.sphinxsidebar input {
188+ border:1px solid #ccc;
189+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
190+ font-size:1em;
191+}
192+
193+div.sphinxsidebar input[type=text] {
194+ margin-left:5px;
195+}
196+
197+a {
198+ color:#5E2750;
199+ text-decoration:none;
200+}
201+
202+a:hover {
203+ color:#DD4814;
204+ text-decoration:underline;
205+}
206+
207+div.body h1 {
208+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
209+ font-weight:bold;
210+ font-size:200%;
211+ color:#444;
212+ margin:20px 0 10px;
213+ padding:5px 0 5px 10px;
214+}
215+
216+div.body h2 {
217+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
218+ font-size:130%;
219+ background-color:#CCC;
220+ margin:20px 0 10px;
221+ padding:5px 0 5px 10px;
222+}
223+
224+div.body h6 {
225+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
226+ background-color:#BED4EB;
227+ font-weight:400;
228+ color:#333;
229+ margin:30px 0 10px;
230+ padding:5px 0 5px 10px;
231+}
232+
233+a.headerlink {
234+ text-decoration:none;
235+ padding:0 4px;
236+}
237+
238+a.headerlink:hover {
239+ background-color:#AEA79F;
240+ color:#FFF;
241+}
242+
243+div.body p,div.body dd,div.body li {
244+ line-height:1.5em;
245+}
246+
247+div.highlight {
248+ background-color:#FFF;
249+}
250+
251+div.note {
252+ background-color:#eee;
253+ border:1px solid #ccc;
254+}
255+
256+div.seealso {
257+ background-color:#ffc;
258+ border:1px solid #ff6;
259+}
260+
261+div.warning {
262+ background-color:#ffe4e4;
263+ border:1px solid #f66;
264+}
265+
266+p.admonition-title:after {
267+ content:":";
268+}
269+
270+pre {
271+ background-color:#EFEFEF;
272+ color:#000;
273+ line-height:1.1em;
274+ border:1px solid #C6C9CB;
275+ font-size:1.2em;
276+ font-family:"Ubuntu Mono", Monaco, Consolas, "DejaVu Sans Mono", "Lucida Console", monospace;
277+ margin:1.5em 0;
278+ padding:6px;
279+}
280+
281+tt {
282+ background-color:#EFEFEF;
283+ color:#222;
284+ font-size:1.1em;
285+ font-family:"Ubuntu Mono", Monaco, Consolas, "DejaVu Sans Mono", "Lucida Console", monospace;
286+}
287+
288+.viewcode-back {
289+ font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
290+}
291+
292+div.viewcode-block:target {
293+ background-color:#f4debf;
294+ border-top:1px solid #ac9;
295+ border-bottom:1px solid #ac9;
296+}
297+
298+div.document,div.topic {
299+ background-color:#eee;
300+}
301+
302+div.sphinxsidebar h3 a,div.sphinxsidebar a {
303+ color:#444;
304+}
305+
306+div.admonition p.admonition-title + p,p.admonition-title {
307+ display:inline;
308+}
309
310=== added directory 'docs-autopilot-emulator/_templates'
311=== added file 'docs-autopilot-emulator/_templates/layout.html'
312--- docs-autopilot-emulator/_templates/layout.html 1970-01-01 00:00:00 +0000
313+++ docs-autopilot-emulator/_templates/layout.html 2014-02-18 20:17:53 +0000
314@@ -0,0 +1,28 @@
315+<!--
316+ Copyright 2013 Canonical Ltd.
317+-->
318+
319+{#
320+ default/layout.html
321+ ~~~~~~~~~~~~~~~~~~~
322+
323+ Sphinx layout template for the default theme.
324+
325+ :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
326+ :license: BSD, see LICENSE for details.
327+#}
328+{% extends "basic/layout.html" %}
329+
330+{%- block content %}
331+<div class="document">
332+ {%- block document %}
333+ <div class="documentwrapper">
334+ {%- if render_sidebar %}
335+ <div class="bodywrapper">
336+ {%- endif %}
337+ <div class="body">
338+ {% block body %} {% endblock %}
339+ </div>
340+ </div>
341+ {%- endblock %}
342+{%- endblock %}
343\ No newline at end of file
344
345=== added file 'docs-autopilot-emulator/conf.py'
346--- docs-autopilot-emulator/conf.py 1970-01-01 00:00:00 +0000
347+++ docs-autopilot-emulator/conf.py 2014-02-18 20:17:53 +0000
348@@ -0,0 +1,290 @@
349+#-*- coding: utf-8 -*-
350+#
351+#ubuntu-ui-toolkit-autopilot documentation build configuration file, created by
352+#sphinx-quickstart on Fri Jul 26 12:12:45 2013.
353+#
354+#This file is execfile()d with the current directory set to its containing dir.
355+#
356+#Note that not all possible configuration values are present in this
357+#autogenerated file.
358+#
359+#All configuration values have a default; values that are commented out
360+#serve to show the default.
361+
362+import sys
363+import os
364+
365+#If extensions (or modules to document with autodoc) are in another directory,
366+#add these directories to sys.path here. If the directory is relative to the
367+#documentation root, use os.path.abspath to make it absolute, like shown here.
368+sys.path.insert(0, os.path.abspath('../tests/autopilot/'))
369+
370+#-- General configuration -----------------------------------------------------
371+
372+#If your documentation needs a minimal Sphinx version, state it here.
373+#needs_sphinx = '1.0'
374+
375+#Add any Sphinx extension module names here, as strings. They can be extensions
376+#coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
377+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
378+
379+#Add any paths that contain templates here, relative to this directory.
380+templates_path = ['_templates']
381+
382+#The suffix of source filenames.
383+source_suffix = '.rst'
384+
385+#The encoding of source files.
386+#source_encoding = 'utf-8-sig'
387+
388+#The master toctree document.
389+master_doc = 'index'
390+
391+#General information about the project.
392+project = u'ubuntu-ui-toolkit-autopilot'
393+copyright = u'2013, Canonical'
394+
395+#The version info for the project you're documenting, acts as replacement for
396+#|version| and |release|, also used in various other places throughout the
397+#built documents.
398+#
399+#The short X.Y version.
400+version = ''
401+#The full version, including alpha/beta/rc tags.
402+release = ''
403+
404+#The language for content autogenerated by Sphinx. Refer to documentation
405+#for a list of supported languages.
406+#language = None
407+
408+#There are two options for replacing |today|: either, you set today to some
409+#non-false value, then it is used:
410+#today = ''
411+#Else, today_fmt is used as the format for a strftime call.
412+#today_fmt = '%B %d, %Y'
413+
414+#List of patterns, relative to source directory, that match files and
415+#directories to ignore when looking for source files.
416+exclude_patterns = ['_build']
417+
418+#The reST default role (used for this markup: `text`) to use for all documents.
419+#default_role = None
420+
421+#If true, '()' will be appended to :func: etc. cross-reference text.
422+#add_function_parentheses = True
423+
424+#If true, the current module name will be prepended to all description
425+#unit titles (such as .. function::).
426+#add_module_names = True
427+
428+#If true, sectionauthor and moduleauthor directives will be shown in the
429+#output. They are ignored by default.
430+#show_authors = False
431+
432+#The name of the Pygments (syntax highlighting) style to use.
433+pygments_style = 'sphinx'
434+
435+#A list of ignored prefixes for module index sorting.
436+#modindex_common_prefix = []
437+
438+
439+#-- Options for HTML output ---------------------------------------------------
440+
441+#The theme to use for HTML and HTML Help pages. See the documentation for
442+#a list of builtin themes.
443+html_theme = 'nature'
444+
445+#Theme options are theme-specific and customize the look and feel of a theme
446+#further. For a list of options available for each theme, see the
447+#documentation.
448+#html_theme_options = {}
449+
450+#Add any paths that contain custom themes here, relative to this directory.
451+#html_theme_path = []
452+
453+#The name for this set of Sphinx documents. If None, it defaults to
454+#"<project> v<release> documentation".
455+#html_title = None
456+
457+#A shorter title for the navigation bar. Default is the same as html_title.
458+#html_short_title = None
459+
460+#The name of an image file (relative to this directory) to place at the top
461+#of the sidebar.
462+#html_logo = None
463+
464+#The name of an image file (within the static path) to use as favicon of the
465+#docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
466+#pixels large.
467+html_favicon = 'favicon.ico'
468+
469+#Add any paths that contain custom static files (such as style sheets) here,
470+#relative to this directory. They are copied after the builtin static files,
471+#so a file named "default.css" will overwrite the builtin "default.css".
472+html_static_path = ['_static']
473+
474+#If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
475+#using the given strftime format.
476+#html_last_updated_fmt = '%b %d, %Y'
477+
478+#If true, SmartyPants will be used to convert quotes and dashes to
479+#typographically correct entities.
480+#html_use_smartypants = True
481+
482+#Custom sidebar templates, maps document names to template names.
483+#html_sidebars = {}
484+
485+#Additional templates that should be rendered to pages, maps page names to
486+#template names.
487+#html_additional_pages = {}
488+
489+#If false, no module index is generated.
490+html_domain_indices = True
491+
492+#If false, no index is generated.
493+html_use_index = True
494+
495+#If true, the index is split into individual pages for each letter.
496+#html_split_index = False
497+
498+#If true, links to the reST sources are added to the pages.
499+html_show_sourcelink = False
500+
501+#If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
502+html_show_sphinx = False
503+
504+#If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
505+html_show_copyright = True
506+
507+#If true, an OpenSearch description file will be output, and all pages will
508+#contain a <link> tag referring to it. The value of this option must be the
509+#base URL from which the finished HTML is served.
510+#html_use_opensearch = ''
511+
512+#This is the file name suffix for HTML files (e.g. ".xhtml").
513+html_file_suffix = '.html'
514+
515+#Output file base name for HTML help builder.
516+htmlhelp_basename = 'ubuntu-ui-toolkit-autopilotdoc'
517+
518+
519+#-- Options for LaTeX output --------------------------------------------------
520+
521+latex_elements = {
522+ #The paper size ('letterpaper' or 'a4paper').
523+ #'papersize': 'letterpaper',
524+
525+ #The font size ('10pt', '11pt' or '12pt').
526+ #'pointsize': '10pt',
527+
528+ #Additional stuff for the LaTeX preamble.
529+ #'preamble': '',
530+}
531+
532+#Grouping the document tree into LaTeX files. List of tuples
533+#(source start file, target name, title, author, documentclass [howto/manual]).
534+latex_documents = [
535+ ('index', 'ubuntu-ui-toolkit-autopilot.tex',
536+ u'ubuntu-ui-toolkit-autopilot Documentation',
537+ u'authors', 'manual'),
538+]
539+
540+#The name of an image file (relative to this directory) to place at the top of
541+#the title page.
542+#latex_logo = None
543+
544+#For "manual" documents, if this is true, then toplevel headings are parts,
545+#not chapters.
546+#latex_use_parts = False
547+
548+#If true, show page references after internal links.
549+#latex_show_pagerefs = False
550+
551+#If true, show URL addresses after external links.
552+#latex_show_urls = False
553+
554+#Documents to append as an appendix to all manuals.
555+#latex_appendices = []
556+
557+#If false, no module index is generated.
558+#latex_domain_indices = True
559+
560+
561+#-- Options for manual page output --------------------------------------------
562+
563+#One entry per manual page. List of tuples
564+#(source start file, name, description, authors, manual section).
565+man_pages = [
566+ ('index', 'ubuntu-ui-toolkit-autopilot',
567+ u'ubuntu-ui-toolkit-autopilot Documentation',
568+ [u'authors'], 1)
569+]
570+
571+#If true, show URL addresses after external links.
572+#man_show_urls = False
573+
574+
575+#-- Options for Texinfo output ------------------------------------------------
576+
577+#Grouping the document tree into Texinfo files. List of tuples
578+#(source start file, target name, title, author,
579+# dir menu entry, description, category)
580+texinfo_documents = [
581+ ('index', 'ubuntu-ui-toolkit-autopilot',
582+ u'ubuntu-ui-toolkit-autopilot Documentation',
583+ u'authors', 'ubuntu-ui-toolkit-autopilot',
584+ 'An autopilot emulator for the ubuntu sdk',
585+ 'Miscellaneous'),
586+]
587+
588+#Documents to append as an appendix to all manuals.
589+#texinfo_appendices = []
590+
591+#If false, no module index is generated.
592+#texinfo_domain_indices = True
593+
594+#How to display URL addresses: 'footnote', 'no', or 'inline'.
595+#texinfo_show_urls = 'footnote'
596+
597+
598+#-- Options for Epub output ---------------------------------------------------
599+
600+#Bibliographic Dublin Core info.
601+epub_title = u'ubuntu-ui-toolkit-autopilot'
602+epub_author = u'authors'
603+epub_publisher = u'Canonical'
604+epub_copyright = u'2013, Canonical'
605+
606+#The language of the text. It defaults to the language option
607+#or en if the language is not set.
608+#epub_language = ''
609+
610+#The scheme of the identifier. Typical schemes are ISBN or URL.
611+#epub_scheme = ''
612+
613+#The unique identifier of the text. This can be a ISBN number
614+#or the project homepage.
615+#epub_identifier = ''
616+
617+#A unique identification for the text.
618+#epub_uid = ''
619+
620+#A tuple containing the cover image and cover page html template filenames.
621+#epub_cover = ()
622+
623+#HTML files that should be inserted before the pages created by sphinx.
624+#The format is a list of tuples containing the path and title.
625+#epub_pre_files = []
626+
627+#HTML files shat should be inserted after the pages created by sphinx.
628+#The format is a list of tuples containing the path and title.
629+#epub_post_files = []
630+
631+#A list of files that should not be packed into the epub file.
632+#epub_exclude_files = []
633+
634+#The depth of the table of contents in toc.ncx.
635+#epub_tocdepth = 3
636+
637+#Allow duplicate toc entries.
638+#epub_tocdup = True
639
640=== added file 'docs-autopilot-emulator/index.rst'
641--- docs-autopilot-emulator/index.rst 1970-01-01 00:00:00 +0000
642+++ docs-autopilot-emulator/index.rst 2014-02-18 20:17:53 +0000
643@@ -0,0 +1,23 @@
644+.. ubuntu-ui-toolkit-autopilot documentation master file, created by
645+ sphinx-quickstart on Fri Jul 26 12:12:45 2013.
646+ You can adapt this file completely to your liking, but it should at least
647+ contain the root `toctree` directive.
648+
649+Welcome to ubuntu-ui-toolkit-autopilot's documentation!
650+=======================================================
651+
652+Contents:
653+
654+.. toctree::
655+ :maxdepth: 4
656+
657+ ubuntuuitoolkit
658+
659+
660+Indices and tables
661+==================
662+
663+* :ref:`genindex`
664+* :ref:`modindex`
665+* :ref:`search`
666+
667
668=== added file 'docs-autopilot-emulator/ubuntuuitoolkit.rst'
669--- docs-autopilot-emulator/ubuntuuitoolkit.rst 1970-01-01 00:00:00 +0000
670+++ docs-autopilot-emulator/ubuntuuitoolkit.rst 2014-02-18 20:17:53 +0000
671@@ -0,0 +1,10 @@
672+ubuntuuitoolkit Package
673+=======================
674+
675+:mod:`emulators` Module
676+-----------------------
677+
678+.. automodule:: ubuntuuitoolkit.emulators
679+ :members:
680+ :undoc-members:
681+ :show-inheritance:

Subscribers

People subscribed via source and target branches

to status/vote changes: