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
=== modified file 'README'
--- README 2013-04-24 17:09:29 +0000
+++ README 2014-02-18 20:17:53 +0000
@@ -47,6 +47,26 @@
47Documentation47Documentation
48-------------48-------------
4949
50Main Documentation (QDocs):
51+++++++++++++++++++++++++++
52
50Once built, you may view the documentation by opening 53Once built, you may view the documentation by opening
51 documentation/html/overview-ubuntu-sdk.html54`documentation/html/overview-ubuntu-sdk.html` in your favorite web browser.
52in your favorite web browser.55
56
57Autopilot Emulators (Sphinx docs):
58++++++++++++++++++++++++++++++++++
59
60To build the AutoPilot Emulators API documentation (html),
61
62 * install python-sphinx::
63
64 $ sudo apt-get install python-sphinx
65
66 * from the branch's root, run::
67
68 $ sphinx-build -b html docs-autopilot-emulator emulator-html
69
70 * Once built, you may view the documentation by opening
71 `emulator-html/ubuntuuitoolkit.html` in your favorite web browser.
72
5373
=== modified file 'debian/changelog'
--- debian/changelog 2014-02-12 10:56:52 +0000
+++ debian/changelog 2014-02-18 20:17:53 +0000
@@ -434,6 +434,12 @@
434434
435 -- Ubuntu daily release <ps-jenkins@lists.canonical.com> Tue, 05 Nov 2013 16:51:13 +0000435 -- Ubuntu daily release <ps-jenkins@lists.canonical.com> Tue, 05 Nov 2013 16:51:13 +0000
436436
437ubuntu-ui-toolkit (0.1.46+13.10.20131011.2-0ubuntu2) UNRELEASED; urgency=low
438
439 * add sphinx documentation
440
441 -- Nicholas Skaggs <nicholas.skaggs@canonical.com> Tue, 29 Oct 2013 17:28:30 -0400
442
437ubuntu-ui-toolkit (0.1.46+13.10.20131011.2-0ubuntu1) saucy; urgency=low443ubuntu-ui-toolkit (0.1.46+13.10.20131011.2-0ubuntu1) saucy; urgency=low
438444
439 [ Zsombor Egri ]445 [ Zsombor Egri ]
440446
=== modified file 'debian/control'
--- debian/control 2014-01-30 13:37:10 +0000
+++ debian/control 2014-02-18 20:17:53 +0000
@@ -38,10 +38,12 @@
38 xvfb,38 xvfb,
39 libgl1-mesa-dri,39 libgl1-mesa-dri,
40 locales,40 locales,
41 python-sphinx,
42 python-autopilot (>= 1.4),
41Standards-Version: 3.9.443Standards-Version: 3.9.4
42Homepage: https://launchpad.net/ubuntu-ui-toolkit44Homepage: https://launchpad.net/ubuntu-ui-toolkit
43# If you aren't a member of ~ubuntu-sdk-team but need to upload packaging 45# If you aren't a member of ~ubuntu-sdk-team but need to upload packaging
44# changes, just go ahead. ~ubuntu-sdk-team will notice and sync up the code 46# changes, just go ahead. ~ubuntu-sdk-team will notice and sync up the code
45# again.47# again.
46Vcs-Bzr: https://code.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/trunk48Vcs-Bzr: https://code.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/trunk
4749
4850
=== modified file 'debian/rules'
--- debian/rules 2013-12-18 15:54:38 +0000
+++ debian/rules 2014-02-18 20:17:53 +0000
@@ -17,6 +17,8 @@
17 dh_auto_build -- docs17 dh_auto_build -- docs
1818
19override_dh_install:19override_dh_install:
20 mkdir -p debian/tmp/`qmake -query QT_INSTALL_DOCS`/qch 20 dh_auto_build -- docs
21 sphinx-build -b html docs-autopilot-emulator docs-autopilot-emulator/_build/html
22 mkdir -p debian/tmp/`qmake -query QT_INSTALL_DOCS`/qch
21 dh_install --fail-missing23 dh_install --fail-missing
2224
2325
=== 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 2014-02-18 20:17:53 +0000
@@ -0,0 +1,1 @@
1docs-autopilot-emulator/_build/html
02
=== added directory 'docs-autopilot-emulator'
=== added directory 'docs-autopilot-emulator/_static'
=== added file 'docs-autopilot-emulator/_static/favicon.ico'
1Binary 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 differ3Binary 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
=== added file 'docs-autopilot-emulator/_static/nature.css'
--- docs-autopilot-emulator/_static/nature.css 1970-01-01 00:00:00 +0000
+++ docs-autopilot-emulator/_static/nature.css 2014-02-18 20:17:53 +0000
@@ -0,0 +1,211 @@
1/*
2 Copyright 2013 Canonical Ltd.
3*/
4
5 @import url(basic.css);
6
7body {
8 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
9 font-size:100%;
10 background-color:#2C001E;
11 margin:0;
12 padding:0;
13 }
14
15div.documentwrapper {
16 float:left;
17 width:100%;
18}
19
20div.bodywrapper {
21 margin:0 0 0 0;
22}
23
24hr {
25 border:1px solid #B1B4B6;
26}
27
28div.body {
29 background-color:#FFF;
30 color:#3E4349;
31 font-size:.9em;
32 padding:0 30px 30px;
33}
34
35div.footer {
36 color:#CCC;
37 width:100%;
38 text-align:center;
39 font-size:75%;
40 padding:13px 0;
41}
42
43div.footer a {
44 color:#444;
45 text-decoration:underline;
46}
47
48div.related {
49 background-color:#DD4814;
50 line-height:32px;
51 color:#fff;
52 font-size:.9em;
53}
54
55div.related a {
56 color:#EEE;
57}
58
59div.sphinxsidebar {
60 font-size:.75em;
61 line-height:1.5em;
62}
63
64div.sphinxsidebarwrapper {
65 padding:20px 0;
66}
67
68div.sphinxsidebar h3,
69div.sphinxsidebar h4 {
70 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
71 color:#222;
72 font-size:1.2em;
73 font-weight:400;
74 background-color:#ddd;
75 margin:0;
76 padding:5px 10px;
77}
78
79div.sphinxsidebar p {
80 color:#444;
81 padding:2px 10px;
82}
83
84div.sphinxsidebar ul {
85 color:#000;
86 margin:10px 5px;
87 padding:0;
88}
89
90div.sphinxsidebar input {
91 border:1px solid #ccc;
92 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
93 font-size:1em;
94}
95
96div.sphinxsidebar input[type=text] {
97 margin-left:5px;
98}
99
100a {
101 color:#5E2750;
102 text-decoration:none;
103}
104
105a:hover {
106 color:#DD4814;
107 text-decoration:underline;
108}
109
110div.body h1 {
111 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
112 font-weight:bold;
113 font-size:200%;
114 color:#444;
115 margin:20px 0 10px;
116 padding:5px 0 5px 10px;
117}
118
119div.body h2 {
120 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
121 font-size:130%;
122 background-color:#CCC;
123 margin:20px 0 10px;
124 padding:5px 0 5px 10px;
125}
126
127div.body h6 {
128 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
129 background-color:#BED4EB;
130 font-weight:400;
131 color:#333;
132 margin:30px 0 10px;
133 padding:5px 0 5px 10px;
134}
135
136a.headerlink {
137 text-decoration:none;
138 padding:0 4px;
139}
140
141a.headerlink:hover {
142 background-color:#AEA79F;
143 color:#FFF;
144}
145
146div.body p,div.body dd,div.body li {
147 line-height:1.5em;
148}
149
150div.highlight {
151 background-color:#FFF;
152}
153
154div.note {
155 background-color:#eee;
156 border:1px solid #ccc;
157}
158
159div.seealso {
160 background-color:#ffc;
161 border:1px solid #ff6;
162}
163
164div.warning {
165 background-color:#ffe4e4;
166 border:1px solid #f66;
167}
168
169p.admonition-title:after {
170 content:":";
171}
172
173pre {
174 background-color:#EFEFEF;
175 color:#000;
176 line-height:1.1em;
177 border:1px solid #C6C9CB;
178 font-size:1.2em;
179 font-family:"Ubuntu Mono", Monaco, Consolas, "DejaVu Sans Mono", "Lucida Console", monospace;
180 margin:1.5em 0;
181 padding:6px;
182}
183
184tt {
185 background-color:#EFEFEF;
186 color:#222;
187 font-size:1.1em;
188 font-family:"Ubuntu Mono", Monaco, Consolas, "DejaVu Sans Mono", "Lucida Console", monospace;
189}
190
191.viewcode-back {
192 font-family:Ubuntu, "DejaVu Sans", "Trebuchet MS", sans-serif;
193}
194
195div.viewcode-block:target {
196 background-color:#f4debf;
197 border-top:1px solid #ac9;
198 border-bottom:1px solid #ac9;
199}
200
201div.document,div.topic {
202 background-color:#eee;
203}
204
205div.sphinxsidebar h3 a,div.sphinxsidebar a {
206 color:#444;
207}
208
209div.admonition p.admonition-title + p,p.admonition-title {
210 display:inline;
211}
0212
=== added directory 'docs-autopilot-emulator/_templates'
=== added file 'docs-autopilot-emulator/_templates/layout.html'
--- docs-autopilot-emulator/_templates/layout.html 1970-01-01 00:00:00 +0000
+++ docs-autopilot-emulator/_templates/layout.html 2014-02-18 20:17:53 +0000
@@ -0,0 +1,28 @@
1<!--
2 Copyright 2013 Canonical Ltd.
3-->
4
5{#
6 default/layout.html
7 ~~~~~~~~~~~~~~~~~~~
8
9 Sphinx layout template for the default theme.
10
11 :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
12 :license: BSD, see LICENSE for details.
13#}
14{% extends "basic/layout.html" %}
15
16{%- block content %}
17<div class="document">
18 {%- block document %}
19 <div class="documentwrapper">
20 {%- if render_sidebar %}
21 <div class="bodywrapper">
22 {%- endif %}
23 <div class="body">
24 {% block body %} {% endblock %}
25 </div>
26 </div>
27 {%- endblock %}
28{%- endblock %}
0\ No newline at end of file29\ No newline at end of file
130
=== added file 'docs-autopilot-emulator/conf.py'
--- docs-autopilot-emulator/conf.py 1970-01-01 00:00:00 +0000
+++ docs-autopilot-emulator/conf.py 2014-02-18 20:17:53 +0000
@@ -0,0 +1,290 @@
1#-*- coding: utf-8 -*-
2#
3#ubuntu-ui-toolkit-autopilot documentation build configuration file, created by
4#sphinx-quickstart on Fri Jul 26 12:12:45 2013.
5#
6#This file is execfile()d with the current directory set to its containing dir.
7#
8#Note that not all possible configuration values are present in this
9#autogenerated file.
10#
11#All configuration values have a default; values that are commented out
12#serve to show the default.
13
14import sys
15import os
16
17#If extensions (or modules to document with autodoc) are in another directory,
18#add these directories to sys.path here. If the directory is relative to the
19#documentation root, use os.path.abspath to make it absolute, like shown here.
20sys.path.insert(0, os.path.abspath('../tests/autopilot/'))
21
22#-- General configuration -----------------------------------------------------
23
24#If your documentation needs a minimal Sphinx version, state it here.
25#needs_sphinx = '1.0'
26
27#Add any Sphinx extension module names here, as strings. They can be extensions
28#coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
29extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
30
31#Add any paths that contain templates here, relative to this directory.
32templates_path = ['_templates']
33
34#The suffix of source filenames.
35source_suffix = '.rst'
36
37#The encoding of source files.
38#source_encoding = 'utf-8-sig'
39
40#The master toctree document.
41master_doc = 'index'
42
43#General information about the project.
44project = u'ubuntu-ui-toolkit-autopilot'
45copyright = u'2013, Canonical'
46
47#The version info for the project you're documenting, acts as replacement for
48#|version| and |release|, also used in various other places throughout the
49#built documents.
50#
51#The short X.Y version.
52version = ''
53#The full version, including alpha/beta/rc tags.
54release = ''
55
56#The language for content autogenerated by Sphinx. Refer to documentation
57#for a list of supported languages.
58#language = None
59
60#There are two options for replacing |today|: either, you set today to some
61#non-false value, then it is used:
62#today = ''
63#Else, today_fmt is used as the format for a strftime call.
64#today_fmt = '%B %d, %Y'
65
66#List of patterns, relative to source directory, that match files and
67#directories to ignore when looking for source files.
68exclude_patterns = ['_build']
69
70#The reST default role (used for this markup: `text`) to use for all documents.
71#default_role = None
72
73#If true, '()' will be appended to :func: etc. cross-reference text.
74#add_function_parentheses = True
75
76#If true, the current module name will be prepended to all description
77#unit titles (such as .. function::).
78#add_module_names = True
79
80#If true, sectionauthor and moduleauthor directives will be shown in the
81#output. They are ignored by default.
82#show_authors = False
83
84#The name of the Pygments (syntax highlighting) style to use.
85pygments_style = 'sphinx'
86
87#A list of ignored prefixes for module index sorting.
88#modindex_common_prefix = []
89
90
91#-- Options for HTML output ---------------------------------------------------
92
93#The theme to use for HTML and HTML Help pages. See the documentation for
94#a list of builtin themes.
95html_theme = 'nature'
96
97#Theme options are theme-specific and customize the look and feel of a theme
98#further. For a list of options available for each theme, see the
99#documentation.
100#html_theme_options = {}
101
102#Add any paths that contain custom themes here, relative to this directory.
103#html_theme_path = []
104
105#The name for this set of Sphinx documents. If None, it defaults to
106#"<project> v<release> documentation".
107#html_title = None
108
109#A shorter title for the navigation bar. Default is the same as html_title.
110#html_short_title = None
111
112#The name of an image file (relative to this directory) to place at the top
113#of the sidebar.
114#html_logo = None
115
116#The name of an image file (within the static path) to use as favicon of the
117#docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
118#pixels large.
119html_favicon = 'favicon.ico'
120
121#Add any paths that contain custom static files (such as style sheets) here,
122#relative to this directory. They are copied after the builtin static files,
123#so a file named "default.css" will overwrite the builtin "default.css".
124html_static_path = ['_static']
125
126#If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127#using the given strftime format.
128#html_last_updated_fmt = '%b %d, %Y'
129
130#If true, SmartyPants will be used to convert quotes and dashes to
131#typographically correct entities.
132#html_use_smartypants = True
133
134#Custom sidebar templates, maps document names to template names.
135#html_sidebars = {}
136
137#Additional templates that should be rendered to pages, maps page names to
138#template names.
139#html_additional_pages = {}
140
141#If false, no module index is generated.
142html_domain_indices = True
143
144#If false, no index is generated.
145html_use_index = True
146
147#If true, the index is split into individual pages for each letter.
148#html_split_index = False
149
150#If true, links to the reST sources are added to the pages.
151html_show_sourcelink = False
152
153#If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
154html_show_sphinx = False
155
156#If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
157html_show_copyright = True
158
159#If true, an OpenSearch description file will be output, and all pages will
160#contain a <link> tag referring to it. The value of this option must be the
161#base URL from which the finished HTML is served.
162#html_use_opensearch = ''
163
164#This is the file name suffix for HTML files (e.g. ".xhtml").
165html_file_suffix = '.html'
166
167#Output file base name for HTML help builder.
168htmlhelp_basename = 'ubuntu-ui-toolkit-autopilotdoc'
169
170
171#-- Options for LaTeX output --------------------------------------------------
172
173latex_elements = {
174 #The paper size ('letterpaper' or 'a4paper').
175 #'papersize': 'letterpaper',
176
177 #The font size ('10pt', '11pt' or '12pt').
178 #'pointsize': '10pt',
179
180 #Additional stuff for the LaTeX preamble.
181 #'preamble': '',
182}
183
184#Grouping the document tree into LaTeX files. List of tuples
185#(source start file, target name, title, author, documentclass [howto/manual]).
186latex_documents = [
187 ('index', 'ubuntu-ui-toolkit-autopilot.tex',
188 u'ubuntu-ui-toolkit-autopilot Documentation',
189 u'authors', 'manual'),
190]
191
192#The name of an image file (relative to this directory) to place at the top of
193#the title page.
194#latex_logo = None
195
196#For "manual" documents, if this is true, then toplevel headings are parts,
197#not chapters.
198#latex_use_parts = False
199
200#If true, show page references after internal links.
201#latex_show_pagerefs = False
202
203#If true, show URL addresses after external links.
204#latex_show_urls = False
205
206#Documents to append as an appendix to all manuals.
207#latex_appendices = []
208
209#If false, no module index is generated.
210#latex_domain_indices = True
211
212
213#-- Options for manual page output --------------------------------------------
214
215#One entry per manual page. List of tuples
216#(source start file, name, description, authors, manual section).
217man_pages = [
218 ('index', 'ubuntu-ui-toolkit-autopilot',
219 u'ubuntu-ui-toolkit-autopilot Documentation',
220 [u'authors'], 1)
221]
222
223#If true, show URL addresses after external links.
224#man_show_urls = False
225
226
227#-- Options for Texinfo output ------------------------------------------------
228
229#Grouping the document tree into Texinfo files. List of tuples
230#(source start file, target name, title, author,
231# dir menu entry, description, category)
232texinfo_documents = [
233 ('index', 'ubuntu-ui-toolkit-autopilot',
234 u'ubuntu-ui-toolkit-autopilot Documentation',
235 u'authors', 'ubuntu-ui-toolkit-autopilot',
236 'An autopilot emulator for the ubuntu sdk',
237 'Miscellaneous'),
238]
239
240#Documents to append as an appendix to all manuals.
241#texinfo_appendices = []
242
243#If false, no module index is generated.
244#texinfo_domain_indices = True
245
246#How to display URL addresses: 'footnote', 'no', or 'inline'.
247#texinfo_show_urls = 'footnote'
248
249
250#-- Options for Epub output ---------------------------------------------------
251
252#Bibliographic Dublin Core info.
253epub_title = u'ubuntu-ui-toolkit-autopilot'
254epub_author = u'authors'
255epub_publisher = u'Canonical'
256epub_copyright = u'2013, Canonical'
257
258#The language of the text. It defaults to the language option
259#or en if the language is not set.
260#epub_language = ''
261
262#The scheme of the identifier. Typical schemes are ISBN or URL.
263#epub_scheme = ''
264
265#The unique identifier of the text. This can be a ISBN number
266#or the project homepage.
267#epub_identifier = ''
268
269#A unique identification for the text.
270#epub_uid = ''
271
272#A tuple containing the cover image and cover page html template filenames.
273#epub_cover = ()
274
275#HTML files that should be inserted before the pages created by sphinx.
276#The format is a list of tuples containing the path and title.
277#epub_pre_files = []
278
279#HTML files shat should be inserted after the pages created by sphinx.
280#The format is a list of tuples containing the path and title.
281#epub_post_files = []
282
283#A list of files that should not be packed into the epub file.
284#epub_exclude_files = []
285
286#The depth of the table of contents in toc.ncx.
287#epub_tocdepth = 3
288
289#Allow duplicate toc entries.
290#epub_tocdup = True
0291
=== added file 'docs-autopilot-emulator/index.rst'
--- docs-autopilot-emulator/index.rst 1970-01-01 00:00:00 +0000
+++ docs-autopilot-emulator/index.rst 2014-02-18 20:17:53 +0000
@@ -0,0 +1,23 @@
1.. ubuntu-ui-toolkit-autopilot documentation master file, created by
2 sphinx-quickstart on Fri Jul 26 12:12:45 2013.
3 You can adapt this file completely to your liking, but it should at least
4 contain the root `toctree` directive.
5
6Welcome to ubuntu-ui-toolkit-autopilot's documentation!
7=======================================================
8
9Contents:
10
11.. toctree::
12 :maxdepth: 4
13
14 ubuntuuitoolkit
15
16
17Indices and tables
18==================
19
20* :ref:`genindex`
21* :ref:`modindex`
22* :ref:`search`
23
024
=== added file 'docs-autopilot-emulator/ubuntuuitoolkit.rst'
--- docs-autopilot-emulator/ubuntuuitoolkit.rst 1970-01-01 00:00:00 +0000
+++ docs-autopilot-emulator/ubuntuuitoolkit.rst 2014-02-18 20:17:53 +0000
@@ -0,0 +1,10 @@
1ubuntuuitoolkit Package
2=======================
3
4:mod:`emulators` Module
5-----------------------
6
7.. automodule:: ubuntuuitoolkit.emulators
8 :members:
9 :undoc-members:
10 :show-inheritance:

Subscribers

People subscribed via source and target branches

to status/vote changes: