Merge lp:~nskaggs/ubuntu-ui-toolkit/sphinx-autopilot-emulator into lp:ubuntu-ui-toolkit

Proposed by Nicholas Skaggs on 2013-08-14
Status: Work in progress
Proposed branch: lp:~nskaggs/ubuntu-ui-toolkit/sphinx-autopilot-emulator
Merge into: lp:ubuntu-ui-toolkit
Diff against target: 530 lines (+508/-0)
4 files modified
documentation/conf.py (+285/-0)
documentation/index.rst (+23/-0)
documentation/make.bat (+190/-0)
documentation/ubuntuuitoolkit.rst (+10/-0)
To merge this branch: bzr merge lp:~nskaggs/ubuntu-ui-toolkit/sphinx-autopilot-emulator
Reviewer Review Type Date Requested Status
Corey Goldberg (community) Needs Fixing on 2013-10-07
PS Jenkins bot continuous-integration Needs Fixing on 2013-10-02
Leo Arias (community) code review. Approve on 2013-08-14
Ubuntu SDK team 2013-08-14 Pending
Review via email: mp+180220@code.launchpad.net

Commit message

Merge in the sphinx build for the autopilot docs.

Description of the change

Can we merge in the sphinx build for the autopilot docs. I'm a sphinx newb, so this isn't intended to be beautiful. Comments welcome. This is already being used here:

http://developer.ubuntu.com/api/devel/ubuntu-13.04/autopilot/_modules/ubuntuuitoolkit/

To post a comment you must log in.
Nicholas Skaggs (nskaggs) wrote :

The current doc generation uses qdoc, and I don't think we can use it for the autopilot emulator. If we somehow can, let's do that. This only builds the autopilot emulator docs, not any of the actual toolkit documentation. Thus if merged, 2 build systems would be in place. I expect some tweaks to this even if the go-ahead is sought.

Leo Arias (elopio) wrote :

I think qdoc doesn't support python, and sphinx doesn't support qml. So there's no way to avoid the two systems.

review: Approve (code review.)
697. By Tim Peeters on 2013-08-16

Add a drag threshold to Panel (and Toolbar) so that unintentional movements while clicking are not detected as a drag to open/close the panel. Fixes: https://bugs.launchpad.net/bugs/1179569.

Approved by Zsombor Egri, PS Jenkins bot, Tim Peeters.

698. By PS Jenkins bot on 2013-08-19

Releasing 0.1.46+13.10.20130819-0ubuntu1 (revision 697 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

699. By Zsombor Egri on 2013-08-19

Alarm management QML API.

Approved by Christian Dywan, PS Jenkins bot, Zsombor Egri.

700. By PS Jenkins bot on 2013-08-19

Releasing 0.1.46+13.10.20130819.3-0ubuntu1 (revision 699 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

701. By Omer Akram on 2013-08-21

make the input device detection logic inside autopilot emulators actually work.

Approved by Günter Schwann, PS Jenkins bot.

702. By Omer Akram on 2013-08-21

first step for autopilot tests to run on touch devices.

Approved by Günter Schwann, PS Jenkins bot.

703. By Michael Zanetti on 2013-08-21

Make Popover themable and allow inheriting Popover's default style.

Approved by PS Jenkins bot, Tim Peeters.

704. By PS Jenkins bot on 2013-08-21

Releasing 0.1.46+13.10.20130821-0ubuntu1 (revision 703 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

705. By Launchpad Translations on behalf of ubuntu-sdk-team on 2013-08-22

Launchpad automatic translations update.

706. By Alexandre Abreu on 2013-08-22

Add an actionmanager property that let clients be more flexible with their actions at runtime. Fixes: https://bugs.launchpad.net/bugs/1207804.

Approved by PS Jenkins bot.

707. By Tim Peeters on 2013-08-22

Do not trigger a ToolbarButton that is not enabled. Fixes: https://bugs.launchpad.net/bugs/1202245.

Approved by PS Jenkins bot, Christian Dywan.

708. By PS Jenkins bot on 2013-08-22

Releasing 0.1.46+13.10.20130822.1-0ubuntu1 (revision 707 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

709. By Launchpad Translations on behalf of ubuntu-sdk-team on 2013-08-23

Launchpad automatic translations update.

710. By Zsombor Egri on 2013-08-23

AlarmModel got a role named model to solve ambiguous role accessing situations. Test application added.

Approved by Christian Dywan, PS Jenkins bot.

711. By PS Jenkins bot on 2013-08-23

Releasing 0.1.46+13.10.20130823-0ubuntu1 (revision 710 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

712. By Zsombor Egri on 2013-08-26

Alarm backend turned to asynchronous implementation. Status enum and corresponding property added to Alarm element to reflect the pending operation status.

Approved by Christian Dywan, PS Jenkins bot.

713. By PS Jenkins bot on 2013-08-26

Releasing 0.1.46+13.10.20130826.1-0ubuntu1 (revision 712 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

714. By Nicolas d'Offay on 2013-08-27

Themed UbuntuShape OptionSelector. Fixes: https://bugs.launchpad.net/bugs/1202170.

Approved by Christian Dywan, PS Jenkins bot, Michał Sawicz.

715. By PS Jenkins bot on 2013-08-27

Releasing 0.1.46+13.10.20130827-0ubuntu1 (revision 714 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

716. By Zsombor Egri on 2013-08-28

Fixing Unity8 crash with the latest SDK release. (LP: #1217650)

717. By Timo Jyrinki on 2013-08-28

Sync changelog.

718. By PS Jenkins bot on 2013-08-28

Releasing 0.1.46+13.10.20130828-0ubuntu1 (revision 717 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

719. By Michael Zanetti on 2013-08-28

add a test for PopoverForegroundStyle.

Approved by PS Jenkins bot.

720. By Nicolas d'Offay on 2013-08-28

Fixed output issue: CrossFadeImage.qml:39: Unable to assign QSize to QSizeF. Fixes: https://bugs.launchpad.net/bugs/1217848.

Approved by Zsombor Egri, PS Jenkins bot.

721. By PS Jenkins bot on 2013-08-28

Releasing 0.1.46+13.10.20130828.1-0ubuntu1 (revision 719 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

722. By Nicolas d'Offay on 2013-08-28

Themed UbuntuShape OptionSelector. Fixes: https://bugs.launchpad.net/bugs/1202170.

Approved by PS Jenkins bot, Zsombor Egri, Christian Dywan, Michał Sawicz.

723. By PS Jenkins bot on 2013-08-29

Releasing 0.1.46+13.10.20130829-0ubuntu1 (revision 722 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

724. By Zsombor Egri on 2013-08-29

Tick artwork reverted into Ambiance theme breaking Switch and CheckBox components. .

Approved by PS Jenkins bot.

725. By Antti Kaijanmäki on 2013-08-29

Add UnityThemeIconProvider - A QQuickImageProvider that loads icons from the current icon theme, following the xdg icon spec.

Approved by PS Jenkins bot, Lars Uebernickel, Michał Sawicz, Michal Hruby.

726. By Olivier Tilloy on 2013-08-29

Fix a typo in Panel.qml. Fixes: https://bugs.launchpad.net/bugs/1218331.

Approved by PS Jenkins bot, Zsombor Egri.

727. By PS Jenkins bot on 2013-08-29

Releasing 0.1.46+13.10.20130829.1-0ubuntu1 (revision 725 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

728. By PS Jenkins bot on 2013-08-29

Releasing 0.1.46+13.10.20130829.2-0ubuntu1 (revision 727 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

729. By Tim Peeters on 2013-08-30

Quick fix, completely untested. Might mess up apps with list items that do not use popovers. Have a look to see if you can use this code and it doesn't break anything. Fixes: https://bugs.launchpad.net/bugs/1205094.

Approved by Zsombor Egri, PS Jenkins bot.

730. By I Ahmad on 2013-08-30

ajusted the buttons laytout to make it fit to phone screen size. https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1218749
. Fixes: https://bugs.launchpad.net/bugs/1218749.

Approved by PS Jenkins bot, Zsombor Egri.

731. By Tim Peeters on 2013-08-30

Clean toolbar code by removing deprecated properties and updating tests.

Approved by PS Jenkins bot.

732. By PS Jenkins bot on 2013-08-30

Releasing 0.1.46+13.10.20130830.1-0ubuntu1 (revision 731 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

733. By Launchpad Translations on behalf of ubuntu-sdk-team on 2013-08-31

Launchpad automatic translations update.

734. By Tim Peeters on 2013-09-02

New toolbar reveal/hide behavior, as specified by design. Fixes: https://bugs.launchpad.net/bugs/1207369.

Approved by Zsombor Egri, PS Jenkins bot.

735. By Nicolas d'Offay on 2013-09-02

Added ItemSelector.
Extend OptionSelector and fixed various bugs.
Added tests for both OptionSelector and ItemSelector. Fixes: https://bugs.launchpad.net/bugs/1169258, https://bugs.launchpad.net/bugs/1218247, https://bugs.launchpad.net/bugs/1218250.

Approved by PS Jenkins bot, Zoltan Balogh.

736. By I Ahmad on 2013-09-03

This MP contains some fixes to autopilot test cases. Two test cases are commented for now as they were giving inconsistent results on phone. .

Approved by PS Jenkins bot, Zsombor Egri.

737. By Zsombor Egri on 2013-09-03

Branch 734 removed, causing Unity test failures.

Approved by PS Jenkins bot.

738. By Zoltan Balogh on 2013-09-03

Reverse cherrypicking rev734.

Approved by PS Jenkins bot, Łukasz Zemczak.

739. By Günter Schwann on 2013-09-03

Fixes tab switching with open toolbar fixes https://bugs.launchpad.net/ubuntu-ui-toolkit/+bug/1220064. Fixes: https://bugs.launchpad.net/bugs/1220064.

Approved by PS Jenkins bot.

740. By PS Jenkins bot on 2013-09-03

Releasing 0.1.46+13.10.20130903.3-0ubuntu1 (revision 738 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

741. By Nicolas d'Offay on 2013-09-03

Hide header label if no label is input.

Fix for: OptionSelector.qml:205: ReferenceError: UbuntuAnimation is not defined

Fixed containerHeight affecting the entire Selector's height even if the contentHeight was less. Fixes: https://bugs.launchpad.net/bugs/1220130.

Approved by Zsombor Egri, PS Jenkins bot.

742. By PS Jenkins bot on 2013-09-03

Releasing 0.1.46+13.10.20130903.4-0ubuntu1 (revision 741 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

743. By Leo Arias on 2013-09-05

Do not duplicate the pointer instantiation on the autopilot emulators. Fixes: https://bugs.launchpad.net/bugs/1220346.

Approved by Thomi Richards, PS Jenkins bot.

744. By Launchpad Translations on behalf of ubuntu-sdk-team on 2013-09-08

Launchpad automatic translations update.

745. By Lars Karlitski on 2013-09-09

giconprovider: warn about image://gicon being deprecated.

Approved by Tim Peeters, PS Jenkins bot.

746. By Nicolas d'Offay on 2013-09-10

Fixed bug in the selectors that happened with the "nudging" behaviour which occurred when the selector was scrolled.

It used to nudge past boundaries and if the same index was selected. This has been fixed.

Fixed SuruDark and SuruGradient ListItemSelector themes.

Approved by PS Jenkins bot, Zsombor Egri.

747. By Tim Peeters on 2013-09-11

Add Panel.open() and Panel.close() functions so that applications can be adapted to use those instead of setting Panel.opened. The behavior of the panel was not changed, this will be done in a following MR.

Also note that applications with a Toolbar do not need to use Panel.open()/close()/opened directly, they can use the opened property of the Page.tools, so they should not be affected by the upcoming changes.

Approved by Tim Peeters, PS Jenkins bot.

748. By Zsombor Egri on 2013-09-11

Picker component, a tumbler style value selector.

Approved by PS Jenkins bot.

749. By PS Jenkins bot on 2013-09-16

Releasing 0.1.46+13.10.20130916-0ubuntu1 (revision 748 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

750. By Launchpad Translations on behalf of ubuntu-sdk-team on 2013-09-17

Launchpad automatic translations update.

751. By Leo Arias on 2013-09-20

Added UbuntuUIToolkitAppTestCase as a base test case for the autopilot tests. Fixes: https://bugs.launchpad.net/bugs/1227355.

Approved by PS Jenkins bot, Omer Akram.

752. By Christian Dywan on 2013-09-23

Set QCoreApplication::applicationName based on MainView. Fixes: https://bugs.launchpad.net/bugs/1197051, https://bugs.launchpad.net/bugs/1197056, https://bugs.launchpad.net/bugs/1224126.

Approved by PS Jenkins bot, Zsombor Egri.

753. By Tim Peeters on 2013-09-23

Fix warnings when running gallery-app autopilot tests. Fixes: https://bugs.launchpad.net/bugs/1223326, https://bugs.launchpad.net/bugs/1223329.

Approved by PS Jenkins bot, Tim Peeters, Zsombor Egri.

754. By Tim Peeters on 2013-09-23

Smarter automatic updating of Panel's opened property.

Panel.open() and Panel.close() should be used to open/close a Panel, or when using a toolbar with ToolbarItems from a Page, set Page.tools.opened to open/close the toolbar.

No API or behavior changes since the panel-open-close branch. Toolbar behavior changes will be done in a following MR.

Approved by PS Jenkins bot, Tim Peeters, Zsombor Egri.

755. By Zsombor Egri on 2013-09-23

Organizer EDS (Evolution Data Server) integration.

Approved by PS Jenkins bot, Tim Peeters.

756. By Leo Arias on 2013-09-24

Added the autopilot emulator for toggles.

Approved by PS Jenkins bot, I Ahmad, Nicholas Skaggs.

757. By Christian Dywan on 2013-09-24

Include subfolders of Components in api check.

Approved by PS Jenkins bot, Zsombor Egri.

758. By Timo Jyrinki on 2013-09-24

Temporarily disable the jokes example in order to not have qtmultimedia dependency from examples that is not used otherwise. This lessens the dependency chains of packages. It can be added back after Ubuntu 13.10.

Approved by PS Jenkins bot, Zoltan Balogh.

759. By Alberto Mardegan on 2013-09-24

Support re-attaching to a different QQuickView

Make the plugin correctly handle the case when the QQuickView is destroyed and
a new one is created: this is done by avoiding using static variables, and
instead binding the data to the QQmlEngine, QQmlContext or QWindow as
appropriate.
. Fixes: https://bugs.launchpad.net/bugs/1221707.

Approved by PS Jenkins bot, Zsombor Egri.

760. By Timo Jyrinki on 2013-09-24

Fix regression in qmlscene usage (LP: #1229541). Fixes: https://bugs.launchpad.net/bugs/1229541.

Approved by PS Jenkins bot.

761. By Dennis O'Flaherty on 2013-09-24

Reword the description for easier reading.

Approved by PS Jenkins bot, Zsombor Egri.

762. By Zsombor Egri on 2013-09-24

StateSaver attached component.

Approved by PS Jenkins bot, Christian Dywan.

763. By Zsombor Egri on 2013-09-24

Fix alarm status reporting, updating documentation on asynchronous behavior of save and cancel operations. Alarm status notification reports the operation the status refers to. Fixes: https://bugs.launchpad.net/bugs/1226516.

Approved by PS Jenkins bot, Christian Dywan.

764. By Zsombor Egri on 2013-09-24

Dialer + DialerHand components required for TimePicker. .

Approved by PS Jenkins bot, Christian Dywan.

765. By Nick Dedekind on 2013-09-25

Added clipping to tab bar. Fixes: https://bugs.launchpad.net/bugs/1226104.

Approved by PS Jenkins bot, Tim Peeters.

766. By PS Jenkins bot on 2013-09-25

Releasing 0.1.46+13.10.20130925.1-0ubuntu1 (revision 765 from lp:ubuntu-ui-toolkit).

Approved by PS Jenkins bot.

767. By Zsombor Egri on 2013-09-25

Fix Picker module deployment.

Approved by PS Jenkins bot, Christian Dywan, Zoltan Balogh.

768. By Nicholas Skaggs on 2013-09-26

updated to current trunk

Nicholas Skaggs (nskaggs) wrote :

Trying to force a rebuild for this ;-)

Christian Dywan (kalikiana) wrote :

Test failure:
Found 1 license problems:
documentation/conf.py GENERATED FILE = u'2013, authors'

769. By Nicholas Skaggs on 2013-09-27

fix authors issues and cleanup path

Nicholas Skaggs (nskaggs) wrote :

Trying to force a rebuild for this again . . .

770. By Nicholas Skaggs on 2013-10-02

update to trunk

Corey Goldberg (coreygoldberg) wrote :

the sphinx docs are mixed in with the qdocs under /documentation... making things pretty confusing.
I am going to branch this branch, update with trunk, separate the 2 doc systems, re-style the sphinx docs, and supersede this MP.

-Corey

review: Needs Fixing

Unmerged revisions

770. By Nicholas Skaggs on 2013-10-02

update to trunk

769. By Nicholas Skaggs on 2013-09-27

fix authors issues and cleanup path

768. By Nicholas Skaggs on 2013-09-26

updated to current trunk

Preview Diff

[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
=== added directory 'documentation/_static'
=== added directory 'documentation/_templates'
=== added file 'documentation/conf.py'
--- documentation/conf.py 1970-01-01 00:00:00 +0000
+++ documentation/conf.py 2013-10-02 21:03:29 +0000
@@ -0,0 +1,285 @@
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, os
15
16# If extensions (or modules to document with autodoc) are in another directory,
17# add these directories to sys.path here. If the directory is relative to the
18# documentation root, use os.path.abspath to make it absolute, like shown here.
19sys.path.insert(0, os.path.abspath('../ubuntu-ui-toolkit/tests/autopilot/'))
20
21# -- General configuration -----------------------------------------------------
22
23# If your documentation needs a minimal Sphinx version, state it here.
24#needs_sphinx = '1.0'
25
26# Add any Sphinx extension module names here, as strings. They can be extensions
27# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
29
30# Add any paths that contain templates here, relative to this directory.
31templates_path = ['_templates']
32
33# The suffix of source filenames.
34source_suffix = '.rst'
35
36# The encoding of source files.
37#source_encoding = 'utf-8-sig'
38
39# The master toctree document.
40master_doc = 'index'
41
42# General information about the project.
43project = u'ubuntu-ui-toolkit-autopilot'
44copyright = u'2013, Canonical'
45
46# The version info for the project you're documenting, acts as replacement for
47# |version| and |release|, also used in various other places throughout the
48# built documents.
49#
50# The short X.Y version.
51version = ''
52# The full version, including alpha/beta/rc tags.
53release = '1'
54
55# The language for content autogenerated by Sphinx. Refer to documentation
56# for a list of supported languages.
57#language = None
58
59# There are two options for replacing |today|: either, you set today to some
60# non-false value, then it is used:
61#today = ''
62# Else, today_fmt is used as the format for a strftime call.
63#today_fmt = '%B %d, %Y'
64
65# List of patterns, relative to source directory, that match files and
66# directories to ignore when looking for source files.
67exclude_patterns = ['_build']
68
69# The reST default role (used for this markup: `text`) to use for all documents.
70#default_role = None
71
72# If true, '()' will be appended to :func: etc. cross-reference text.
73#add_function_parentheses = True
74
75# If true, the current module name will be prepended to all description
76# unit titles (such as .. function::).
77#add_module_names = True
78
79# If true, sectionauthor and moduleauthor directives will be shown in the
80# output. They are ignored by default.
81#show_authors = False
82
83# The name of the Pygments (syntax highlighting) style to use.
84pygments_style = 'sphinx'
85
86# A list of ignored prefixes for module index sorting.
87#modindex_common_prefix = []
88
89
90# -- Options for HTML output ---------------------------------------------------
91
92# The theme to use for HTML and HTML Help pages. See the documentation for
93# a list of builtin themes.
94html_theme = 'default'
95
96# Theme options are theme-specific and customize the look and feel of a theme
97# further. For a list of options available for each theme, see the
98# documentation.
99#html_theme_options = {}
100
101# Add any paths that contain custom themes here, relative to this directory.
102#html_theme_path = []
103
104# The name for this set of Sphinx documents. If None, it defaults to
105# "<project> v<release> documentation".
106#html_title = None
107
108# A shorter title for the navigation bar. Default is the same as html_title.
109#html_short_title = None
110
111# The name of an image file (relative to this directory) to place at the top
112# of the sidebar.
113#html_logo = None
114
115# The name of an image file (within the static path) to use as favicon of the
116# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
117# pixels large.
118#html_favicon = None
119
120# Add any paths that contain custom static files (such as style sheets) here,
121# relative to this directory. They are copied after the builtin static files,
122# so a file named "default.css" will overwrite the builtin "default.css".
123html_static_path = ['_static']
124
125# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
126# using the given strftime format.
127#html_last_updated_fmt = '%b %d, %Y'
128
129# If true, SmartyPants will be used to convert quotes and dashes to
130# typographically correct entities.
131#html_use_smartypants = True
132
133# Custom sidebar templates, maps document names to template names.
134#html_sidebars = {}
135
136# Additional templates that should be rendered to pages, maps page names to
137# template names.
138#html_additional_pages = {}
139
140# If false, no module index is generated.
141#html_domain_indices = True
142
143# If false, no index is generated.
144#html_use_index = True
145
146# If true, the index is split into individual pages for each letter.
147#html_split_index = False
148
149# If true, links to the reST sources are added to the pages.
150#html_show_sourcelink = True
151
152# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
153#html_show_sphinx = True
154
155# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
156#html_show_copyright = True
157
158# If true, an OpenSearch description file will be output, and all pages will
159# contain a <link> tag referring to it. The value of this option must be the
160# base URL from which the finished HTML is served.
161#html_use_opensearch = ''
162
163# This is the file name suffix for HTML files (e.g. ".xhtml").
164#html_file_suffix = None
165
166# Output file base name for HTML help builder.
167htmlhelp_basename = 'ubuntu-ui-toolkit-autopilotdoc'
168
169
170# -- Options for LaTeX output --------------------------------------------------
171
172latex_elements = {
173# The paper size ('letterpaper' or 'a4paper').
174#'papersize': 'letterpaper',
175
176# The font size ('10pt', '11pt' or '12pt').
177#'pointsize': '10pt',
178
179# Additional stuff for the LaTeX preamble.
180#'preamble': '',
181}
182
183# Grouping the document tree into LaTeX files. List of tuples
184# (source start file, target name, title, author, documentclass [howto/manual]).
185latex_documents = [
186 ('index', 'ubuntu-ui-toolkit-autopilot.tex', u'ubuntu-ui-toolkit-autopilot Documentation',
187 u'authors', 'manual'),
188]
189
190# The name of an image file (relative to this directory) to place at the top of
191# the title page.
192#latex_logo = None
193
194# For "manual" documents, if this is true, then toplevel headings are parts,
195# not chapters.
196#latex_use_parts = False
197
198# If true, show page references after internal links.
199#latex_show_pagerefs = False
200
201# If true, show URL addresses after external links.
202#latex_show_urls = False
203
204# Documents to append as an appendix to all manuals.
205#latex_appendices = []
206
207# If false, no module index is generated.
208#latex_domain_indices = True
209
210
211# -- Options for manual page output --------------------------------------------
212
213# One entry per manual page. List of tuples
214# (source start file, name, description, authors, manual section).
215man_pages = [
216 ('index', 'ubuntu-ui-toolkit-autopilot', u'ubuntu-ui-toolkit-autopilot Documentation',
217 [u'authors'], 1)
218]
219
220# If true, show URL addresses after external links.
221#man_show_urls = False
222
223
224# -- Options for Texinfo output ------------------------------------------------
225
226# Grouping the document tree into Texinfo files. List of tuples
227# (source start file, target name, title, author,
228# dir menu entry, description, category)
229texinfo_documents = [
230 ('index', 'ubuntu-ui-toolkit-autopilot', u'ubuntu-ui-toolkit-autopilot Documentation',
231 u'authors', 'ubuntu-ui-toolkit-autopilot', 'An autopilot emulator for the ubuntu sdk',
232 'Miscellaneous'),
233]
234
235# Documents to append as an appendix to all manuals.
236#texinfo_appendices = []
237
238# If false, no module index is generated.
239#texinfo_domain_indices = True
240
241# How to display URL addresses: 'footnote', 'no', or 'inline'.
242#texinfo_show_urls = 'footnote'
243
244
245# -- Options for Epub output ---------------------------------------------------
246
247# Bibliographic Dublin Core info.
248epub_title = u'ubuntu-ui-toolkit-autopilot'
249epub_author = u'authors'
250epub_publisher = u'Canonical'
251epub_copyright = u'2013, Canonical'
252
253# The language of the text. It defaults to the language option
254# or en if the language is not set.
255#epub_language = ''
256
257# The scheme of the identifier. Typical schemes are ISBN or URL.
258#epub_scheme = ''
259
260# The unique identifier of the text. This can be a ISBN number
261# or the project homepage.
262#epub_identifier = ''
263
264# A unique identification for the text.
265#epub_uid = ''
266
267# A tuple containing the cover image and cover page html template filenames.
268#epub_cover = ()
269
270# HTML files that should be inserted before the pages created by sphinx.
271# The format is a list of tuples containing the path and title.
272#epub_pre_files = []
273
274# HTML files shat should be inserted after the pages created by sphinx.
275# The format is a list of tuples containing the path and title.
276#epub_post_files = []
277
278# A list of files that should not be packed into the epub file.
279#epub_exclude_files = []
280
281# The depth of the table of contents in toc.ncx.
282#epub_tocdepth = 3
283
284# Allow duplicate toc entries.
285#epub_tocdup = True
0286
=== removed directory 'documentation/html'
=== added file 'documentation/index.rst'
--- documentation/index.rst 1970-01-01 00:00:00 +0000
+++ documentation/index.rst 2013-10-02 21:03:29 +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 'documentation/make.bat'
--- documentation/make.bat 1970-01-01 00:00:00 +0000
+++ documentation/make.bat 2013-10-02 21:03:29 +0000
@@ -0,0 +1,190 @@
1@ECHO OFF
2
3REM Command file for Sphinx documentation
4
5if "%SPHINXBUILD%" == "" (
6 set SPHINXBUILD=sphinx-build
7)
8set BUILDDIR=_build
9set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% .
10set I18NSPHINXOPTS=%SPHINXOPTS% .
11if NOT "%PAPER%" == "" (
12 set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
13 set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS%
14)
15
16if "%1" == "" goto help
17
18if "%1" == "help" (
19 :help
20 echo.Please use `make ^<target^>` where ^<target^> is one of
21 echo. html to make standalone HTML files
22 echo. dirhtml to make HTML files named index.html in directories
23 echo. singlehtml to make a single large HTML file
24 echo. pickle to make pickle files
25 echo. json to make JSON files
26 echo. htmlhelp to make HTML files and a HTML help project
27 echo. qthelp to make HTML files and a qthelp project
28 echo. devhelp to make HTML files and a Devhelp project
29 echo. epub to make an epub
30 echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
31 echo. text to make text files
32 echo. man to make manual pages
33 echo. texinfo to make Texinfo files
34 echo. gettext to make PO message catalogs
35 echo. changes to make an overview over all changed/added/deprecated items
36 echo. linkcheck to check all external links for integrity
37 echo. doctest to run all doctests embedded in the documentation if enabled
38 goto end
39)
40
41if "%1" == "clean" (
42 for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
43 del /q /s %BUILDDIR%\*
44 goto end
45)
46
47if "%1" == "html" (
48 %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
49 if errorlevel 1 exit /b 1
50 echo.
51 echo.Build finished. The HTML pages are in %BUILDDIR%/html.
52 goto end
53)
54
55if "%1" == "dirhtml" (
56 %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
57 if errorlevel 1 exit /b 1
58 echo.
59 echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
60 goto end
61)
62
63if "%1" == "singlehtml" (
64 %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
65 if errorlevel 1 exit /b 1
66 echo.
67 echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
68 goto end
69)
70
71if "%1" == "pickle" (
72 %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
73 if errorlevel 1 exit /b 1
74 echo.
75 echo.Build finished; now you can process the pickle files.
76 goto end
77)
78
79if "%1" == "json" (
80 %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
81 if errorlevel 1 exit /b 1
82 echo.
83 echo.Build finished; now you can process the JSON files.
84 goto end
85)
86
87if "%1" == "htmlhelp" (
88 %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
89 if errorlevel 1 exit /b 1
90 echo.
91 echo.Build finished; now you can run HTML Help Workshop with the ^
92.hhp project file in %BUILDDIR%/htmlhelp.
93 goto end
94)
95
96if "%1" == "qthelp" (
97 %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
98 if errorlevel 1 exit /b 1
99 echo.
100 echo.Build finished; now you can run "qcollectiongenerator" with the ^
101.qhcp project file in %BUILDDIR%/qthelp, like this:
102 echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ubuntu-ui-toolkit-autopilot.qhcp
103 echo.To view the help file:
104 echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ubuntu-ui-toolkit-autopilot.ghc
105 goto end
106)
107
108if "%1" == "devhelp" (
109 %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
110 if errorlevel 1 exit /b 1
111 echo.
112 echo.Build finished.
113 goto end
114)
115
116if "%1" == "epub" (
117 %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
118 if errorlevel 1 exit /b 1
119 echo.
120 echo.Build finished. The epub file is in %BUILDDIR%/epub.
121 goto end
122)
123
124if "%1" == "latex" (
125 %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
126 if errorlevel 1 exit /b 1
127 echo.
128 echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
129 goto end
130)
131
132if "%1" == "text" (
133 %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
134 if errorlevel 1 exit /b 1
135 echo.
136 echo.Build finished. The text files are in %BUILDDIR%/text.
137 goto end
138)
139
140if "%1" == "man" (
141 %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
142 if errorlevel 1 exit /b 1
143 echo.
144 echo.Build finished. The manual pages are in %BUILDDIR%/man.
145 goto end
146)
147
148if "%1" == "texinfo" (
149 %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo
150 if errorlevel 1 exit /b 1
151 echo.
152 echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo.
153 goto end
154)
155
156if "%1" == "gettext" (
157 %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale
158 if errorlevel 1 exit /b 1
159 echo.
160 echo.Build finished. The message catalogs are in %BUILDDIR%/locale.
161 goto end
162)
163
164if "%1" == "changes" (
165 %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
166 if errorlevel 1 exit /b 1
167 echo.
168 echo.The overview file is in %BUILDDIR%/changes.
169 goto end
170)
171
172if "%1" == "linkcheck" (
173 %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
174 if errorlevel 1 exit /b 1
175 echo.
176 echo.Link check complete; look for any errors in the above output ^
177or in %BUILDDIR%/linkcheck/output.txt.
178 goto end
179)
180
181if "%1" == "doctest" (
182 %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
183 if errorlevel 1 exit /b 1
184 echo.
185 echo.Testing of doctests in the sources finished, look at the ^
186results in %BUILDDIR%/doctest/output.txt.
187 goto end
188)
189
190:end
0191
=== added file 'documentation/ubuntuuitoolkit.rst'
--- documentation/ubuntuuitoolkit.rst 1970-01-01 00:00:00 +0000
+++ documentation/ubuntuuitoolkit.rst 2013-10-02 21:03:29 +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: