Merge lp:~nskaggs/ubuntu-ui-toolkit/sphinx-autopilot-emulator into lp:ubuntu-ui-toolkit
- sphinx-autopilot-emulator
- Merge into trunk
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 |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Corey Goldberg (community) | Needs Fixing | ||
PS Jenkins bot | continuous-integration | Needs Fixing | |
Leo Arias (community) | code review. | Approve | |
Ubuntu SDK team | 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://
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.
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:661
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
- 697. By Tim Peeters
-
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
-
Releasing 0.1.46+
13.10.20130819- 0ubuntu1 (revision 697 from lp:ubuntu-ui-toolkit). Approved by PS Jenkins bot.
- 699. By Zsombor Egri
-
Alarm management QML API.
Approved by Christian Dywan, PS Jenkins bot, Zsombor Egri.
- 700. By PS Jenkins bot
-
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
-
make the input device detection logic inside autopilot emulators actually work.
Approved by Günter Schwann, PS Jenkins bot.
- 702. By Omer Akram
-
first step for autopilot tests to run on touch devices.
Approved by Günter Schwann, PS Jenkins bot.
- 703. By Michael Zanetti
-
Make Popover themable and allow inheriting Popover's default style.
Approved by PS Jenkins bot, Tim Peeters.
- 704. By PS Jenkins bot
-
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
-
Launchpad automatic translations update.
- 706. By Alexandre Abreu
-
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
-
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
-
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
-
Launchpad automatic translations update.
- 710. By Zsombor Egri
-
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
-
Releasing 0.1.46+
13.10.20130823- 0ubuntu1 (revision 710 from lp:ubuntu-ui-toolkit). Approved by PS Jenkins bot.
- 712. By Zsombor Egri
-
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
-
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
-
Themed UbuntuShape OptionSelector. Fixes: https:/
/bugs.launchpad .net/bugs/ 1202170. Approved by Christian Dywan, PS Jenkins bot, Michał Sawicz.
- 715. By PS Jenkins bot
-
Releasing 0.1.46+
13.10.20130827- 0ubuntu1 (revision 714 from lp:ubuntu-ui-toolkit). Approved by PS Jenkins bot.
- 716. By Zsombor Egri
-
Fixing Unity8 crash with the latest SDK release. (LP: #1217650)
- 717. By Timo Jyrinki
-
Sync changelog.
- 718. By PS Jenkins bot
-
Releasing 0.1.46+
13.10.20130828- 0ubuntu1 (revision 717 from lp:ubuntu-ui-toolkit). Approved by PS Jenkins bot.
- 719. By Michael Zanetti
-
add a test for PopoverForegrou
ndStyle. Approved by PS Jenkins bot.
- 720. By Nicolas d'Offay
-
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
-
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
-
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
-
Releasing 0.1.46+
13.10.20130829- 0ubuntu1 (revision 722 from lp:ubuntu-ui-toolkit). Approved by PS Jenkins bot.
- 724. By Zsombor Egri
-
Tick artwork reverted into Ambiance theme breaking Switch and CheckBox components. .
Approved by PS Jenkins bot.
- 725. By Antti Kaijanmäki
-
Add UnityThemeIconP
rovider - 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
-
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
-
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
-
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
-
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
-
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
-
Clean toolbar code by removing deprecated properties and updating tests.
Approved by PS Jenkins bot.
- 732. By PS Jenkins bot
-
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
-
Launchpad automatic translations update.
- 734. By Tim Peeters
-
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
-
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
-
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
-
Branch 734 removed, causing Unity test failures.
Approved by PS Jenkins bot.
- 738. By Zoltan Balogh
-
Reverse cherrypicking rev734.
Approved by PS Jenkins bot, Łukasz Zemczak.
- 739. By Günter Schwann
-
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
-
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
-
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
-
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
-
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
-
Launchpad automatic translations update.
- 745. By Lars Karlitski
-
giconprovider: warn about image://gicon being deprecated.
Approved by Tim Peeters, PS Jenkins bot.
- 746. By Nicolas d'Offay
-
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
-
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
-
Picker component, a tumbler style value selector.
Approved by PS Jenkins bot.
- 749. By PS Jenkins bot
-
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
-
Launchpad automatic translations update.
- 751. By Leo Arias
-
Added UbuntuUIToolkit
AppTestCase 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 Cris Dywan
-
Set QCoreApplicatio
n::applicationN ame 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
-
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
-
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
-
Organizer EDS (Evolution Data Server) integration.
Approved by PS Jenkins bot, Tim Peeters.
- 756. By Leo Arias
-
Added the autopilot emulator for toggles.
Approved by PS Jenkins bot, I Ahmad, Nicholas Skaggs.
- 757. By Cris Dywan
-
Include subfolders of Components in api check.
Approved by PS Jenkins bot, Zsombor Egri.
- 758. By Timo Jyrinki
-
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
-
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
-
Fix regression in qmlscene usage (LP: #1229541). Fixes: https:/
/bugs.launchpad .net/bugs/ 1229541. Approved by PS Jenkins bot.
- 761. By Dennis O'Flaherty
-
Reword the description for easier reading.
Approved by PS Jenkins bot, Zsombor Egri.
- 762. By Zsombor Egri
-
StateSaver attached component.
Approved by PS Jenkins bot, Christian Dywan.
- 763. By Zsombor Egri
-
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
-
Dialer + DialerHand components required for TimePicker. .
Approved by PS Jenkins bot, Christian Dywan.
- 765. By Nick Dedekind
-
Added clipping to tab bar. Fixes: https:/
/bugs.launchpad .net/bugs/ 1226104. Approved by PS Jenkins bot, Tim Peeters.
- 766. By PS Jenkins bot
-
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
-
Fix Picker module deployment.
Approved by PS Jenkins bot, Christian Dywan, Zoltan Balogh.
- 768. By Nicholas Skaggs
-
updated to current trunk
Nicholas Skaggs (nskaggs) wrote : | # |
Trying to force a rebuild for this ;-)
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:768
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
Cris Dywan (kalikiana) wrote : | # |
Test failure:
Found 1 license problems:
documentation/
- 769. By Nicholas Skaggs
-
fix authors issues and cleanup path
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:769
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
Nicholas Skaggs (nskaggs) wrote : | # |
Trying to force a rebuild for this again . . .
- 770. By Nicholas Skaggs
-
update to trunk
PS Jenkins bot (ps-jenkins) wrote : | # |
FAILED: Continuous integration, rev:770
http://
Executed test runs:
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
FAILURE: http://
Click here to trigger a rebuild:
http://
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
Unmerged revisions
- 770. By Nicholas Skaggs
-
update to trunk
- 769. By Nicholas Skaggs
-
fix authors issues and cleanup path
- 768. By Nicholas Skaggs
-
updated to current trunk
Preview Diff
1 | === added directory 'documentation/_static' | |||
2 | === added directory 'documentation/_templates' | |||
3 | === added file 'documentation/conf.py' | |||
4 | --- documentation/conf.py 1970-01-01 00:00:00 +0000 | |||
5 | +++ documentation/conf.py 2013-10-02 21:03:29 +0000 | |||
6 | @@ -0,0 +1,285 @@ | |||
7 | 1 | # -*- coding: utf-8 -*- | ||
8 | 2 | # | ||
9 | 3 | # ubuntu-ui-toolkit-autopilot documentation build configuration file, created by | ||
10 | 4 | # sphinx-quickstart on Fri Jul 26 12:12:45 2013. | ||
11 | 5 | # | ||
12 | 6 | # This file is execfile()d with the current directory set to its containing dir. | ||
13 | 7 | # | ||
14 | 8 | # Note that not all possible configuration values are present in this | ||
15 | 9 | # autogenerated file. | ||
16 | 10 | # | ||
17 | 11 | # All configuration values have a default; values that are commented out | ||
18 | 12 | # serve to show the default. | ||
19 | 13 | |||
20 | 14 | import sys, os | ||
21 | 15 | |||
22 | 16 | # If extensions (or modules to document with autodoc) are in another directory, | ||
23 | 17 | # add these directories to sys.path here. If the directory is relative to the | ||
24 | 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
25 | 19 | sys.path.insert(0, os.path.abspath('../ubuntu-ui-toolkit/tests/autopilot/')) | ||
26 | 20 | |||
27 | 21 | # -- General configuration ----------------------------------------------------- | ||
28 | 22 | |||
29 | 23 | # If your documentation needs a minimal Sphinx version, state it here. | ||
30 | 24 | #needs_sphinx = '1.0' | ||
31 | 25 | |||
32 | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions | ||
33 | 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
34 | 28 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] | ||
35 | 29 | |||
36 | 30 | # Add any paths that contain templates here, relative to this directory. | ||
37 | 31 | templates_path = ['_templates'] | ||
38 | 32 | |||
39 | 33 | # The suffix of source filenames. | ||
40 | 34 | source_suffix = '.rst' | ||
41 | 35 | |||
42 | 36 | # The encoding of source files. | ||
43 | 37 | #source_encoding = 'utf-8-sig' | ||
44 | 38 | |||
45 | 39 | # The master toctree document. | ||
46 | 40 | master_doc = 'index' | ||
47 | 41 | |||
48 | 42 | # General information about the project. | ||
49 | 43 | project = u'ubuntu-ui-toolkit-autopilot' | ||
50 | 44 | copyright = u'2013, Canonical' | ||
51 | 45 | |||
52 | 46 | # The version info for the project you're documenting, acts as replacement for | ||
53 | 47 | # |version| and |release|, also used in various other places throughout the | ||
54 | 48 | # built documents. | ||
55 | 49 | # | ||
56 | 50 | # The short X.Y version. | ||
57 | 51 | version = '' | ||
58 | 52 | # The full version, including alpha/beta/rc tags. | ||
59 | 53 | release = '1' | ||
60 | 54 | |||
61 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
62 | 56 | # for a list of supported languages. | ||
63 | 57 | #language = None | ||
64 | 58 | |||
65 | 59 | # There are two options for replacing |today|: either, you set today to some | ||
66 | 60 | # non-false value, then it is used: | ||
67 | 61 | #today = '' | ||
68 | 62 | # Else, today_fmt is used as the format for a strftime call. | ||
69 | 63 | #today_fmt = '%B %d, %Y' | ||
70 | 64 | |||
71 | 65 | # List of patterns, relative to source directory, that match files and | ||
72 | 66 | # directories to ignore when looking for source files. | ||
73 | 67 | exclude_patterns = ['_build'] | ||
74 | 68 | |||
75 | 69 | # The reST default role (used for this markup: `text`) to use for all documents. | ||
76 | 70 | #default_role = None | ||
77 | 71 | |||
78 | 72 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
79 | 73 | #add_function_parentheses = True | ||
80 | 74 | |||
81 | 75 | # If true, the current module name will be prepended to all description | ||
82 | 76 | # unit titles (such as .. function::). | ||
83 | 77 | #add_module_names = True | ||
84 | 78 | |||
85 | 79 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
86 | 80 | # output. They are ignored by default. | ||
87 | 81 | #show_authors = False | ||
88 | 82 | |||
89 | 83 | # The name of the Pygments (syntax highlighting) style to use. | ||
90 | 84 | pygments_style = 'sphinx' | ||
91 | 85 | |||
92 | 86 | # A list of ignored prefixes for module index sorting. | ||
93 | 87 | #modindex_common_prefix = [] | ||
94 | 88 | |||
95 | 89 | |||
96 | 90 | # -- Options for HTML output --------------------------------------------------- | ||
97 | 91 | |||
98 | 92 | # The theme to use for HTML and HTML Help pages. See the documentation for | ||
99 | 93 | # a list of builtin themes. | ||
100 | 94 | html_theme = 'default' | ||
101 | 95 | |||
102 | 96 | # Theme options are theme-specific and customize the look and feel of a theme | ||
103 | 97 | # further. For a list of options available for each theme, see the | ||
104 | 98 | # documentation. | ||
105 | 99 | #html_theme_options = {} | ||
106 | 100 | |||
107 | 101 | # Add any paths that contain custom themes here, relative to this directory. | ||
108 | 102 | #html_theme_path = [] | ||
109 | 103 | |||
110 | 104 | # The name for this set of Sphinx documents. If None, it defaults to | ||
111 | 105 | # "<project> v<release> documentation". | ||
112 | 106 | #html_title = None | ||
113 | 107 | |||
114 | 108 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
115 | 109 | #html_short_title = None | ||
116 | 110 | |||
117 | 111 | # The name of an image file (relative to this directory) to place at the top | ||
118 | 112 | # of the sidebar. | ||
119 | 113 | #html_logo = None | ||
120 | 114 | |||
121 | 115 | # The name of an image file (within the static path) to use as favicon of the | ||
122 | 116 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
123 | 117 | # pixels large. | ||
124 | 118 | #html_favicon = None | ||
125 | 119 | |||
126 | 120 | # Add any paths that contain custom static files (such as style sheets) here, | ||
127 | 121 | # relative to this directory. They are copied after the builtin static files, | ||
128 | 122 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
129 | 123 | html_static_path = ['_static'] | ||
130 | 124 | |||
131 | 125 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
132 | 126 | # using the given strftime format. | ||
133 | 127 | #html_last_updated_fmt = '%b %d, %Y' | ||
134 | 128 | |||
135 | 129 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
136 | 130 | # typographically correct entities. | ||
137 | 131 | #html_use_smartypants = True | ||
138 | 132 | |||
139 | 133 | # Custom sidebar templates, maps document names to template names. | ||
140 | 134 | #html_sidebars = {} | ||
141 | 135 | |||
142 | 136 | # Additional templates that should be rendered to pages, maps page names to | ||
143 | 137 | # template names. | ||
144 | 138 | #html_additional_pages = {} | ||
145 | 139 | |||
146 | 140 | # If false, no module index is generated. | ||
147 | 141 | #html_domain_indices = True | ||
148 | 142 | |||
149 | 143 | # If false, no index is generated. | ||
150 | 144 | #html_use_index = True | ||
151 | 145 | |||
152 | 146 | # If true, the index is split into individual pages for each letter. | ||
153 | 147 | #html_split_index = False | ||
154 | 148 | |||
155 | 149 | # If true, links to the reST sources are added to the pages. | ||
156 | 150 | #html_show_sourcelink = True | ||
157 | 151 | |||
158 | 152 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. | ||
159 | 153 | #html_show_sphinx = True | ||
160 | 154 | |||
161 | 155 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. | ||
162 | 156 | #html_show_copyright = True | ||
163 | 157 | |||
164 | 158 | # If true, an OpenSearch description file will be output, and all pages will | ||
165 | 159 | # contain a <link> tag referring to it. The value of this option must be the | ||
166 | 160 | # base URL from which the finished HTML is served. | ||
167 | 161 | #html_use_opensearch = '' | ||
168 | 162 | |||
169 | 163 | # This is the file name suffix for HTML files (e.g. ".xhtml"). | ||
170 | 164 | #html_file_suffix = None | ||
171 | 165 | |||
172 | 166 | # Output file base name for HTML help builder. | ||
173 | 167 | htmlhelp_basename = 'ubuntu-ui-toolkit-autopilotdoc' | ||
174 | 168 | |||
175 | 169 | |||
176 | 170 | # -- Options for LaTeX output -------------------------------------------------- | ||
177 | 171 | |||
178 | 172 | latex_elements = { | ||
179 | 173 | # The paper size ('letterpaper' or 'a4paper'). | ||
180 | 174 | #'papersize': 'letterpaper', | ||
181 | 175 | |||
182 | 176 | # The font size ('10pt', '11pt' or '12pt'). | ||
183 | 177 | #'pointsize': '10pt', | ||
184 | 178 | |||
185 | 179 | # Additional stuff for the LaTeX preamble. | ||
186 | 180 | #'preamble': '', | ||
187 | 181 | } | ||
188 | 182 | |||
189 | 183 | # Grouping the document tree into LaTeX files. List of tuples | ||
190 | 184 | # (source start file, target name, title, author, documentclass [howto/manual]). | ||
191 | 185 | latex_documents = [ | ||
192 | 186 | ('index', 'ubuntu-ui-toolkit-autopilot.tex', u'ubuntu-ui-toolkit-autopilot Documentation', | ||
193 | 187 | u'authors', 'manual'), | ||
194 | 188 | ] | ||
195 | 189 | |||
196 | 190 | # The name of an image file (relative to this directory) to place at the top of | ||
197 | 191 | # the title page. | ||
198 | 192 | #latex_logo = None | ||
199 | 193 | |||
200 | 194 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
201 | 195 | # not chapters. | ||
202 | 196 | #latex_use_parts = False | ||
203 | 197 | |||
204 | 198 | # If true, show page references after internal links. | ||
205 | 199 | #latex_show_pagerefs = False | ||
206 | 200 | |||
207 | 201 | # If true, show URL addresses after external links. | ||
208 | 202 | #latex_show_urls = False | ||
209 | 203 | |||
210 | 204 | # Documents to append as an appendix to all manuals. | ||
211 | 205 | #latex_appendices = [] | ||
212 | 206 | |||
213 | 207 | # If false, no module index is generated. | ||
214 | 208 | #latex_domain_indices = True | ||
215 | 209 | |||
216 | 210 | |||
217 | 211 | # -- Options for manual page output -------------------------------------------- | ||
218 | 212 | |||
219 | 213 | # One entry per manual page. List of tuples | ||
220 | 214 | # (source start file, name, description, authors, manual section). | ||
221 | 215 | man_pages = [ | ||
222 | 216 | ('index', 'ubuntu-ui-toolkit-autopilot', u'ubuntu-ui-toolkit-autopilot Documentation', | ||
223 | 217 | [u'authors'], 1) | ||
224 | 218 | ] | ||
225 | 219 | |||
226 | 220 | # If true, show URL addresses after external links. | ||
227 | 221 | #man_show_urls = False | ||
228 | 222 | |||
229 | 223 | |||
230 | 224 | # -- Options for Texinfo output ------------------------------------------------ | ||
231 | 225 | |||
232 | 226 | # Grouping the document tree into Texinfo files. List of tuples | ||
233 | 227 | # (source start file, target name, title, author, | ||
234 | 228 | # dir menu entry, description, category) | ||
235 | 229 | texinfo_documents = [ | ||
236 | 230 | ('index', 'ubuntu-ui-toolkit-autopilot', u'ubuntu-ui-toolkit-autopilot Documentation', | ||
237 | 231 | u'authors', 'ubuntu-ui-toolkit-autopilot', 'An autopilot emulator for the ubuntu sdk', | ||
238 | 232 | 'Miscellaneous'), | ||
239 | 233 | ] | ||
240 | 234 | |||
241 | 235 | # Documents to append as an appendix to all manuals. | ||
242 | 236 | #texinfo_appendices = [] | ||
243 | 237 | |||
244 | 238 | # If false, no module index is generated. | ||
245 | 239 | #texinfo_domain_indices = True | ||
246 | 240 | |||
247 | 241 | # How to display URL addresses: 'footnote', 'no', or 'inline'. | ||
248 | 242 | #texinfo_show_urls = 'footnote' | ||
249 | 243 | |||
250 | 244 | |||
251 | 245 | # -- Options for Epub output --------------------------------------------------- | ||
252 | 246 | |||
253 | 247 | # Bibliographic Dublin Core info. | ||
254 | 248 | epub_title = u'ubuntu-ui-toolkit-autopilot' | ||
255 | 249 | epub_author = u'authors' | ||
256 | 250 | epub_publisher = u'Canonical' | ||
257 | 251 | epub_copyright = u'2013, Canonical' | ||
258 | 252 | |||
259 | 253 | # The language of the text. It defaults to the language option | ||
260 | 254 | # or en if the language is not set. | ||
261 | 255 | #epub_language = '' | ||
262 | 256 | |||
263 | 257 | # The scheme of the identifier. Typical schemes are ISBN or URL. | ||
264 | 258 | #epub_scheme = '' | ||
265 | 259 | |||
266 | 260 | # The unique identifier of the text. This can be a ISBN number | ||
267 | 261 | # or the project homepage. | ||
268 | 262 | #epub_identifier = '' | ||
269 | 263 | |||
270 | 264 | # A unique identification for the text. | ||
271 | 265 | #epub_uid = '' | ||
272 | 266 | |||
273 | 267 | # A tuple containing the cover image and cover page html template filenames. | ||
274 | 268 | #epub_cover = () | ||
275 | 269 | |||
276 | 270 | # HTML files that should be inserted before the pages created by sphinx. | ||
277 | 271 | # The format is a list of tuples containing the path and title. | ||
278 | 272 | #epub_pre_files = [] | ||
279 | 273 | |||
280 | 274 | # HTML files shat should be inserted after the pages created by sphinx. | ||
281 | 275 | # The format is a list of tuples containing the path and title. | ||
282 | 276 | #epub_post_files = [] | ||
283 | 277 | |||
284 | 278 | # A list of files that should not be packed into the epub file. | ||
285 | 279 | #epub_exclude_files = [] | ||
286 | 280 | |||
287 | 281 | # The depth of the table of contents in toc.ncx. | ||
288 | 282 | #epub_tocdepth = 3 | ||
289 | 283 | |||
290 | 284 | # Allow duplicate toc entries. | ||
291 | 285 | #epub_tocdup = True | ||
292 | 0 | 286 | ||
293 | === removed directory 'documentation/html' | |||
294 | === added file 'documentation/index.rst' | |||
295 | --- documentation/index.rst 1970-01-01 00:00:00 +0000 | |||
296 | +++ documentation/index.rst 2013-10-02 21:03:29 +0000 | |||
297 | @@ -0,0 +1,23 @@ | |||
298 | 1 | .. ubuntu-ui-toolkit-autopilot documentation master file, created by | ||
299 | 2 | sphinx-quickstart on Fri Jul 26 12:12:45 2013. | ||
300 | 3 | You can adapt this file completely to your liking, but it should at least | ||
301 | 4 | contain the root `toctree` directive. | ||
302 | 5 | |||
303 | 6 | Welcome to ubuntu-ui-toolkit-autopilot's documentation! | ||
304 | 7 | ======================================================= | ||
305 | 8 | |||
306 | 9 | Contents: | ||
307 | 10 | |||
308 | 11 | .. toctree:: | ||
309 | 12 | :maxdepth: 4 | ||
310 | 13 | |||
311 | 14 | ubuntuuitoolkit | ||
312 | 15 | |||
313 | 16 | |||
314 | 17 | Indices and tables | ||
315 | 18 | ================== | ||
316 | 19 | |||
317 | 20 | * :ref:`genindex` | ||
318 | 21 | * :ref:`modindex` | ||
319 | 22 | * :ref:`search` | ||
320 | 23 | |||
321 | 0 | 24 | ||
322 | === added file 'documentation/make.bat' | |||
323 | --- documentation/make.bat 1970-01-01 00:00:00 +0000 | |||
324 | +++ documentation/make.bat 2013-10-02 21:03:29 +0000 | |||
325 | @@ -0,0 +1,190 @@ | |||
326 | 1 | @ECHO OFF | ||
327 | 2 | |||
328 | 3 | REM Command file for Sphinx documentation | ||
329 | 4 | |||
330 | 5 | if "%SPHINXBUILD%" == "" ( | ||
331 | 6 | set SPHINXBUILD=sphinx-build | ||
332 | 7 | ) | ||
333 | 8 | set BUILDDIR=_build | ||
334 | 9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . | ||
335 | 10 | set I18NSPHINXOPTS=%SPHINXOPTS% . | ||
336 | 11 | if NOT "%PAPER%" == "" ( | ||
337 | 12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% | ||
338 | 13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% | ||
339 | 14 | ) | ||
340 | 15 | |||
341 | 16 | if "%1" == "" goto help | ||
342 | 17 | |||
343 | 18 | if "%1" == "help" ( | ||
344 | 19 | :help | ||
345 | 20 | echo.Please use `make ^<target^>` where ^<target^> is one of | ||
346 | 21 | echo. html to make standalone HTML files | ||
347 | 22 | echo. dirhtml to make HTML files named index.html in directories | ||
348 | 23 | echo. singlehtml to make a single large HTML file | ||
349 | 24 | echo. pickle to make pickle files | ||
350 | 25 | echo. json to make JSON files | ||
351 | 26 | echo. htmlhelp to make HTML files and a HTML help project | ||
352 | 27 | echo. qthelp to make HTML files and a qthelp project | ||
353 | 28 | echo. devhelp to make HTML files and a Devhelp project | ||
354 | 29 | echo. epub to make an epub | ||
355 | 30 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter | ||
356 | 31 | echo. text to make text files | ||
357 | 32 | echo. man to make manual pages | ||
358 | 33 | echo. texinfo to make Texinfo files | ||
359 | 34 | echo. gettext to make PO message catalogs | ||
360 | 35 | echo. changes to make an overview over all changed/added/deprecated items | ||
361 | 36 | echo. linkcheck to check all external links for integrity | ||
362 | 37 | echo. doctest to run all doctests embedded in the documentation if enabled | ||
363 | 38 | goto end | ||
364 | 39 | ) | ||
365 | 40 | |||
366 | 41 | if "%1" == "clean" ( | ||
367 | 42 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i | ||
368 | 43 | del /q /s %BUILDDIR%\* | ||
369 | 44 | goto end | ||
370 | 45 | ) | ||
371 | 46 | |||
372 | 47 | if "%1" == "html" ( | ||
373 | 48 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html | ||
374 | 49 | if errorlevel 1 exit /b 1 | ||
375 | 50 | echo. | ||
376 | 51 | echo.Build finished. The HTML pages are in %BUILDDIR%/html. | ||
377 | 52 | goto end | ||
378 | 53 | ) | ||
379 | 54 | |||
380 | 55 | if "%1" == "dirhtml" ( | ||
381 | 56 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml | ||
382 | 57 | if errorlevel 1 exit /b 1 | ||
383 | 58 | echo. | ||
384 | 59 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. | ||
385 | 60 | goto end | ||
386 | 61 | ) | ||
387 | 62 | |||
388 | 63 | if "%1" == "singlehtml" ( | ||
389 | 64 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml | ||
390 | 65 | if errorlevel 1 exit /b 1 | ||
391 | 66 | echo. | ||
392 | 67 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. | ||
393 | 68 | goto end | ||
394 | 69 | ) | ||
395 | 70 | |||
396 | 71 | if "%1" == "pickle" ( | ||
397 | 72 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle | ||
398 | 73 | if errorlevel 1 exit /b 1 | ||
399 | 74 | echo. | ||
400 | 75 | echo.Build finished; now you can process the pickle files. | ||
401 | 76 | goto end | ||
402 | 77 | ) | ||
403 | 78 | |||
404 | 79 | if "%1" == "json" ( | ||
405 | 80 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json | ||
406 | 81 | if errorlevel 1 exit /b 1 | ||
407 | 82 | echo. | ||
408 | 83 | echo.Build finished; now you can process the JSON files. | ||
409 | 84 | goto end | ||
410 | 85 | ) | ||
411 | 86 | |||
412 | 87 | if "%1" == "htmlhelp" ( | ||
413 | 88 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp | ||
414 | 89 | if errorlevel 1 exit /b 1 | ||
415 | 90 | echo. | ||
416 | 91 | echo.Build finished; now you can run HTML Help Workshop with the ^ | ||
417 | 92 | .hhp project file in %BUILDDIR%/htmlhelp. | ||
418 | 93 | goto end | ||
419 | 94 | ) | ||
420 | 95 | |||
421 | 96 | if "%1" == "qthelp" ( | ||
422 | 97 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp | ||
423 | 98 | if errorlevel 1 exit /b 1 | ||
424 | 99 | echo. | ||
425 | 100 | echo.Build finished; now you can run "qcollectiongenerator" with the ^ | ||
426 | 101 | .qhcp project file in %BUILDDIR%/qthelp, like this: | ||
427 | 102 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\ubuntu-ui-toolkit-autopilot.qhcp | ||
428 | 103 | echo.To view the help file: | ||
429 | 104 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\ubuntu-ui-toolkit-autopilot.ghc | ||
430 | 105 | goto end | ||
431 | 106 | ) | ||
432 | 107 | |||
433 | 108 | if "%1" == "devhelp" ( | ||
434 | 109 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp | ||
435 | 110 | if errorlevel 1 exit /b 1 | ||
436 | 111 | echo. | ||
437 | 112 | echo.Build finished. | ||
438 | 113 | goto end | ||
439 | 114 | ) | ||
440 | 115 | |||
441 | 116 | if "%1" == "epub" ( | ||
442 | 117 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub | ||
443 | 118 | if errorlevel 1 exit /b 1 | ||
444 | 119 | echo. | ||
445 | 120 | echo.Build finished. The epub file is in %BUILDDIR%/epub. | ||
446 | 121 | goto end | ||
447 | 122 | ) | ||
448 | 123 | |||
449 | 124 | if "%1" == "latex" ( | ||
450 | 125 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex | ||
451 | 126 | if errorlevel 1 exit /b 1 | ||
452 | 127 | echo. | ||
453 | 128 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. | ||
454 | 129 | goto end | ||
455 | 130 | ) | ||
456 | 131 | |||
457 | 132 | if "%1" == "text" ( | ||
458 | 133 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text | ||
459 | 134 | if errorlevel 1 exit /b 1 | ||
460 | 135 | echo. | ||
461 | 136 | echo.Build finished. The text files are in %BUILDDIR%/text. | ||
462 | 137 | goto end | ||
463 | 138 | ) | ||
464 | 139 | |||
465 | 140 | if "%1" == "man" ( | ||
466 | 141 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man | ||
467 | 142 | if errorlevel 1 exit /b 1 | ||
468 | 143 | echo. | ||
469 | 144 | echo.Build finished. The manual pages are in %BUILDDIR%/man. | ||
470 | 145 | goto end | ||
471 | 146 | ) | ||
472 | 147 | |||
473 | 148 | if "%1" == "texinfo" ( | ||
474 | 149 | %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo | ||
475 | 150 | if errorlevel 1 exit /b 1 | ||
476 | 151 | echo. | ||
477 | 152 | echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. | ||
478 | 153 | goto end | ||
479 | 154 | ) | ||
480 | 155 | |||
481 | 156 | if "%1" == "gettext" ( | ||
482 | 157 | %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale | ||
483 | 158 | if errorlevel 1 exit /b 1 | ||
484 | 159 | echo. | ||
485 | 160 | echo.Build finished. The message catalogs are in %BUILDDIR%/locale. | ||
486 | 161 | goto end | ||
487 | 162 | ) | ||
488 | 163 | |||
489 | 164 | if "%1" == "changes" ( | ||
490 | 165 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes | ||
491 | 166 | if errorlevel 1 exit /b 1 | ||
492 | 167 | echo. | ||
493 | 168 | echo.The overview file is in %BUILDDIR%/changes. | ||
494 | 169 | goto end | ||
495 | 170 | ) | ||
496 | 171 | |||
497 | 172 | if "%1" == "linkcheck" ( | ||
498 | 173 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck | ||
499 | 174 | if errorlevel 1 exit /b 1 | ||
500 | 175 | echo. | ||
501 | 176 | echo.Link check complete; look for any errors in the above output ^ | ||
502 | 177 | or in %BUILDDIR%/linkcheck/output.txt. | ||
503 | 178 | goto end | ||
504 | 179 | ) | ||
505 | 180 | |||
506 | 181 | if "%1" == "doctest" ( | ||
507 | 182 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest | ||
508 | 183 | if errorlevel 1 exit /b 1 | ||
509 | 184 | echo. | ||
510 | 185 | echo.Testing of doctests in the sources finished, look at the ^ | ||
511 | 186 | results in %BUILDDIR%/doctest/output.txt. | ||
512 | 187 | goto end | ||
513 | 188 | ) | ||
514 | 189 | |||
515 | 190 | :end | ||
516 | 0 | 191 | ||
517 | === added file 'documentation/ubuntuuitoolkit.rst' | |||
518 | --- documentation/ubuntuuitoolkit.rst 1970-01-01 00:00:00 +0000 | |||
519 | +++ documentation/ubuntuuitoolkit.rst 2013-10-02 21:03:29 +0000 | |||
520 | @@ -0,0 +1,10 @@ | |||
521 | 1 | ubuntuuitoolkit Package | ||
522 | 2 | ======================= | ||
523 | 3 | |||
524 | 4 | :mod:`emulators` Module | ||
525 | 5 | ----------------------- | ||
526 | 6 | |||
527 | 7 | .. automodule:: ubuntuuitoolkit.emulators | ||
528 | 8 | :members: | ||
529 | 9 | :undoc-members: | ||
530 | 10 | :show-inheritance: |
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.