Merge lp:~springermac/openlp/documentation-api into lp:~openlp-documentation/openlp/trunk
- documentation-api
- Merge into trunk
Proposed by
Jonathan Springer
Status: | Merged |
---|---|
Approved by: | Raoul Snyman |
Approved revision: | 122 |
Merged at revision: | 120 |
Proposed branch: | lp:~springermac/openlp/documentation-api |
Merge into: | lp:~openlp-documentation/openlp/trunk |
Prerequisite: | lp:~springermac/openlp/api-documentation-fixes |
Diff against target: |
1471 lines (+525/-627) 27 files modified
.bzrignore (+1/-0) api/Makefile (+131/-38) api/source/conf.py (+200/-56) api/source/core/index.rst (+0/-18) api/source/core/lib.rst (+0/-79) api/source/core/theme.rst (+0/-10) api/source/core/ui.rst (+0/-30) api/source/core/utils.rst (+0/-7) api/source/doc/mainwindows/maindisplay.rst (+6/-0) api/source/doc/mainwindows/mainwindow.rst (+6/-0) api/source/doc/managers/mediadockmanager.rst (+6/-0) api/source/doc/managers/servicemanager.rst (+6/-0) api/source/doc/managers/slidecontroller.rst (+6/-0) api/source/doc/managers/thememanager.rst (+6/-0) api/source/doc/ui.rst (+20/-0) api/source/index.rst (+17/-9) api/source/plugins/alerts.rst (+0/-31) api/source/plugins/bibles.rst (+0/-55) api/source/plugins/custom.rst (+0/-34) api/source/plugins/images.rst (+0/-22) api/source/plugins/index.rst (+0/-20) api/source/plugins/media.rst (+0/-22) api/source/plugins/presentations.rst (+0/-40) api/source/plugins/remotes.rst (+0/-25) api/source/plugins/songs.rst (+0/-97) api/source/plugins/songusage.rst (+0/-34) api/source/scan.py (+120/-0) |
To merge this branch: | bzr merge lp:~springermac/openlp/documentation-api |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Raoul Snyman | Approve | ||
Review via email: mp+270471@code.launchpad.net |
Commit message
Description of the change
Use script to auto generate OpenLP API documentation
To post a comment you must log in.
Revision history for this message
Tim Bentley (trb143) wrote : | # |
Revision history for this message
Jonathan Springer (springermac) wrote : | # |
My idea with picking out specific classes was to highlight and/or add more documentation about those which should be looked at first when exploring how OpenLP works or developing a plugin for OpenLP.
Revision history for this message
Raoul Snyman (raoul-snyman) : | # |
review:
Approve
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file '.bzrignore' |
2 | --- .bzrignore 2014-11-10 23:06:23 +0000 |
3 | +++ .bzrignore 2015-09-09 01:52:05 +0000 |
4 | @@ -1,3 +1,4 @@ |
5 | build |
6 | .directory |
7 | .idea/ |
8 | +api/source/api |
9 | |
10 | === modified file 'api/Makefile' |
11 | --- api/Makefile 2011-05-08 21:22:30 +0000 |
12 | +++ api/Makefile 2015-09-09 01:52:05 +0000 |
13 | @@ -5,84 +5,177 @@ |
14 | SPHINXOPTS = |
15 | SPHINXBUILD = sphinx-build |
16 | PAPER = |
17 | +BUILDDIR = build |
18 | + |
19 | +# User-friendly check for sphinx-build |
20 | +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) |
21 | +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) |
22 | +endif |
23 | |
24 | # Internal variables. |
25 | PAPEROPT_a4 = -D latex_paper_size=a4 |
26 | PAPEROPT_letter = -D latex_paper_size=letter |
27 | -ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
28 | +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
29 | +# the i18n builder cannot share the environment and doctrees with the others |
30 | +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source |
31 | |
32 | -.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest |
33 | +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext |
34 | |
35 | help: |
36 | @echo "Please use \`make <target>' where <target> is one of" |
37 | - @echo " html to make standalone HTML files" |
38 | - @echo " dirhtml to make HTML files named index.html in directories" |
39 | - @echo " pickle to make pickle files" |
40 | - @echo " json to make JSON files" |
41 | - @echo " htmlhelp to make HTML files and a HTML help project" |
42 | - @echo " qthelp to make HTML files and a qthelp project" |
43 | - @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
44 | - @echo " changes to make an overview of all changed/added/deprecated items" |
45 | - @echo " linkcheck to check all external links for integrity" |
46 | - @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
47 | + @echo " html to make standalone HTML files" |
48 | + @echo " dirhtml to make HTML files named index.html in directories" |
49 | + @echo " singlehtml to make a single large HTML file" |
50 | + @echo " pickle to make pickle files" |
51 | + @echo " json to make JSON files" |
52 | + @echo " htmlhelp to make HTML files and a HTML help project" |
53 | + @echo " qthelp to make HTML files and a qthelp project" |
54 | + @echo " devhelp to make HTML files and a Devhelp project" |
55 | + @echo " epub to make an epub" |
56 | + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" |
57 | + @echo " latexpdf to make LaTeX files and run them through pdflatex" |
58 | + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" |
59 | + @echo " text to make text files" |
60 | + @echo " man to make manual pages" |
61 | + @echo " texinfo to make Texinfo files" |
62 | + @echo " info to make Texinfo files and run them through makeinfo" |
63 | + @echo " gettext to make PO message catalogs" |
64 | + @echo " changes to make an overview of all changed/added/deprecated items" |
65 | + @echo " xml to make Docutils-native XML files" |
66 | + @echo " pseudoxml to make pseudoxml-XML files for display purposes" |
67 | + @echo " linkcheck to check all external links for integrity" |
68 | + @echo " doctest to run all doctests embedded in the documentation (if enabled)" |
69 | + @echo " scan to generate .rst for the OpenLP API from OpenLP's source" |
70 | |
71 | clean: |
72 | - -rm -rf build/* |
73 | + rm -rf $(BUILDDIR)/* |
74 | |
75 | html: |
76 | - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html |
77 | + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html |
78 | @echo |
79 | - @echo "Build finished. The HTML pages are in build/html." |
80 | + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." |
81 | |
82 | dirhtml: |
83 | - $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml |
84 | - @echo |
85 | - @echo "Build finished. The HTML pages are in build/dirhtml." |
86 | + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml |
87 | + @echo |
88 | + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." |
89 | + |
90 | +singlehtml: |
91 | + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml |
92 | + @echo |
93 | + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." |
94 | |
95 | pickle: |
96 | - $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle |
97 | + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle |
98 | @echo |
99 | @echo "Build finished; now you can process the pickle files." |
100 | |
101 | json: |
102 | - $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json |
103 | + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json |
104 | @echo |
105 | @echo "Build finished; now you can process the JSON files." |
106 | |
107 | htmlhelp: |
108 | - $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp |
109 | + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp |
110 | @echo |
111 | @echo "Build finished; now you can run HTML Help Workshop with the" \ |
112 | - ".hhp project file in build/htmlhelp." |
113 | + ".hhp project file in $(BUILDDIR)/htmlhelp." |
114 | |
115 | qthelp: |
116 | - $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp |
117 | + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp |
118 | @echo |
119 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ |
120 | - ".qhcp project file in build/qthelp, like this:" |
121 | - @echo "# qcollectiongenerator build/qthelp/OpenLP.qhcp" |
122 | - @echo "To view the help file:" |
123 | - @echo "# assistant -collectionFile build/qthelp/OpenLP.qhc" |
124 | + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" |
125 | + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLP.qhcp" |
126 | + @echo "To view the help file:" |
127 | + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLP.qhc" |
128 | + |
129 | +devhelp: |
130 | + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp |
131 | + @echo |
132 | + @echo "Build finished." |
133 | + @echo "To view the help file:" |
134 | + @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLP" |
135 | + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLP" |
136 | + @echo "# devhelp" |
137 | + |
138 | +epub: |
139 | + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub |
140 | + @echo |
141 | + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." |
142 | |
143 | latex: |
144 | - $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex |
145 | - @echo |
146 | - @echo "Build finished; the LaTeX files are in build/latex." |
147 | - @echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \ |
148 | - "run these through (pdf)latex." |
149 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
150 | + @echo |
151 | + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." |
152 | + @echo "Run \`make' in that directory to run these through (pdf)latex" \ |
153 | + "(use \`make latexpdf' here to do that automatically)." |
154 | + |
155 | +latexpdf: |
156 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
157 | + @echo "Running LaTeX files through pdflatex..." |
158 | + $(MAKE) -C $(BUILDDIR)/latex all-pdf |
159 | + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
160 | + |
161 | +latexpdfja: |
162 | + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex |
163 | + @echo "Running LaTeX files through platex and dvipdfmx..." |
164 | + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja |
165 | + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." |
166 | + |
167 | +text: |
168 | + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text |
169 | + @echo |
170 | + @echo "Build finished. The text files are in $(BUILDDIR)/text." |
171 | + |
172 | +man: |
173 | + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man |
174 | + @echo |
175 | + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." |
176 | + |
177 | +texinfo: |
178 | + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
179 | + @echo |
180 | + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." |
181 | + @echo "Run \`make' in that directory to run these through makeinfo" \ |
182 | + "(use \`make info' here to do that automatically)." |
183 | + |
184 | +info: |
185 | + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo |
186 | + @echo "Running Texinfo files through makeinfo..." |
187 | + make -C $(BUILDDIR)/texinfo info |
188 | + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." |
189 | + |
190 | +gettext: |
191 | + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale |
192 | + @echo |
193 | + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." |
194 | |
195 | changes: |
196 | - $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes |
197 | + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes |
198 | @echo |
199 | - @echo "The overview file is in build/changes." |
200 | + @echo "The overview file is in $(BUILDDIR)/changes." |
201 | |
202 | linkcheck: |
203 | - $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck |
204 | + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck |
205 | @echo |
206 | @echo "Link check complete; look for any errors in the above output " \ |
207 | - "or in build/linkcheck/output.txt." |
208 | + "or in $(BUILDDIR)/linkcheck/output.txt." |
209 | |
210 | doctest: |
211 | - $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest |
212 | + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest |
213 | @echo "Testing of doctests in the sources finished, look at the " \ |
214 | - "results in build/doctest/output.txt." |
215 | + "results in $(BUILDDIR)/doctest/output.txt." |
216 | + |
217 | +xml: |
218 | + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml |
219 | + @echo |
220 | + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." |
221 | + |
222 | +pseudoxml: |
223 | + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml |
224 | + @echo |
225 | + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." |
226 | + |
227 | +scan: |
228 | + ./source/scan.py |
229 | |
230 | === modified file 'api/source/conf.py' |
231 | --- api/source/conf.py 2012-10-12 19:26:20 +0000 |
232 | +++ api/source/conf.py 2015-09-09 01:52:05 +0000 |
233 | @@ -1,9 +1,11 @@ |
234 | +#!/usr/bin/env python3 |
235 | # -*- coding: utf-8 -*- |
236 | # |
237 | # OpenLP documentation build configuration file, created by |
238 | -# sphinx-quickstart on Fri Jul 10 17:20:40 2009. |
239 | +# sphinx-quickstart on Mon Jun 16 15:48:38 2014. |
240 | # |
241 | -# This file is execfile()d with the current directory set to its containing dir. |
242 | +# This file is execfile()d with the current directory set to its |
243 | +# containing dir. |
244 | # |
245 | # Note that not all possible configuration values are present in this |
246 | # autogenerated file. |
247 | @@ -11,25 +13,36 @@ |
248 | # All configuration values have a default; values that are commented out |
249 | # serve to show the default. |
250 | |
251 | +import sys |
252 | import os |
253 | -import sys |
254 | |
255 | # If extensions (or modules to document with autodoc) are in another directory, |
256 | # add these directories to sys.path here. If the directory is relative to the |
257 | # documentation root, use os.path.abspath to make it absolute, like shown here. |
258 | path_to_code = os.path.abspath(os.path.join(os.path.split(__file__)[0], |
259 | - '..', '..', '..', '..', 'OpenLP', 'trunk')) |
260 | + '..', '..', '..', '..', 'openlp', 'trunk')) |
261 | if not os.path.exists(path_to_code): |
262 | - print 'Incorrect path to code, expecting "%s"' % path_to_code |
263 | + print('Incorrect path to code, expecting "%s"' % path_to_code) |
264 | sys.exit(1) |
265 | |
266 | sys.path.insert(0, path_to_code) |
267 | |
268 | -# -- General configuration ----------------------------------------------------- |
269 | - |
270 | -# Add any Sphinx extension module names here, as strings. They can be extensions |
271 | -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. |
272 | -extensions = ['sphinx.ext.autodoc'] |
273 | +# -- General configuration ------------------------------------------------ |
274 | + |
275 | +# If your documentation needs a minimal Sphinx version, state it here. |
276 | +#needs_sphinx = '1.0' |
277 | + |
278 | +# Add any Sphinx extension module names here, as strings. They can be |
279 | +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
280 | +# ones. |
281 | +extensions = [ |
282 | + 'sphinx.ext.autodoc', |
283 | + 'sphinx.ext.autosummary', |
284 | + 'sphinx.ext.intersphinx', |
285 | + 'sphinx.ext.todo', |
286 | + 'sphinx.ext.coverage', |
287 | + 'sphinx.ext.viewcode' |
288 | +] |
289 | |
290 | # Add any paths that contain templates here, relative to this directory. |
291 | templates_path = ['_templates'] |
292 | @@ -38,23 +51,23 @@ |
293 | source_suffix = '.rst' |
294 | |
295 | # The encoding of source files. |
296 | -source_encoding = 'utf-8' |
297 | +#source_encoding = 'utf-8-sig' |
298 | |
299 | # The master toctree document. |
300 | master_doc = 'index' |
301 | |
302 | # General information about the project. |
303 | -project = u'OpenLP' |
304 | -copyright = u'2004-2012, Raoul Snyman' |
305 | +project = 'OpenLP' |
306 | +copyright = '2004-2015, Raoul Snyman' |
307 | |
308 | # The version info for the project you're documenting, acts as replacement for |
309 | # |version| and |release|, also used in various other places throughout the |
310 | # built documents. |
311 | # |
312 | # The short X.Y version. |
313 | -version = '2.0' |
314 | +version = '2.2' |
315 | # The full version, including alpha/beta/rc tags. |
316 | -release = '1.9.8' |
317 | +release = '2.2' |
318 | |
319 | # The language for content autogenerated by Sphinx. Refer to documentation |
320 | # for a list of supported languages. |
321 | @@ -66,14 +79,12 @@ |
322 | # Else, today_fmt is used as the format for a strftime call. |
323 | #today_fmt = '%B %d, %Y' |
324 | |
325 | -# List of documents that shouldn't be included in the build. |
326 | -#unused_docs = [] |
327 | - |
328 | -# List of directories, relative to source directory, that shouldn't be searched |
329 | -# for source files. |
330 | -exclude_trees = [] |
331 | - |
332 | -# The reST default role (used for this markup: `text`) to use for all documents. |
333 | +# List of patterns, relative to source directory, that match files and |
334 | +# directories to ignore when looking for source files. |
335 | +exclude_patterns = [] |
336 | + |
337 | +# The reST default role (used for this markup: `text`) to use for all |
338 | +# documents. |
339 | #default_role = None |
340 | |
341 | # If true, '()' will be appended to :func: etc. cross-reference text. |
342 | @@ -81,7 +92,7 @@ |
343 | |
344 | # If true, the current module name will be prepended to all description |
345 | # unit titles (such as .. function::). |
346 | -add_module_names = False |
347 | +#add_module_names = True |
348 | |
349 | # If true, sectionauthor and moduleauthor directives will be shown in the |
350 | # output. They are ignored by default. |
351 | @@ -93,31 +104,27 @@ |
352 | # A list of ignored prefixes for module index sorting. |
353 | #modindex_common_prefix = [] |
354 | |
355 | - |
356 | -# -- Options for HTML output --------------------------------------------------- |
357 | - |
358 | -# The theme to use for HTML and HTML Help pages. Major themes that come with |
359 | -# Sphinx are currently 'default' and 'sphinxdoc'. |
360 | -html_theme = 'default' |
361 | +# If true, keep warnings as "system message" paragraphs in the built documents. |
362 | +# keep_warnings = True |
363 | + |
364 | + |
365 | +# -- Options for HTML output ---------------------------------------------- |
366 | + |
367 | +# The theme to use for HTML and HTML Help pages. See the documentation for |
368 | +# a list of builtin themes. |
369 | +html_theme = 'sphinx_rtd_theme' |
370 | |
371 | # Theme options are theme-specific and customize the look and feel of a theme |
372 | # further. For a list of options available for each theme, see the |
373 | # documentation. |
374 | -html_theme_options = { |
375 | - 'sidebarbgcolor': '#3a60a9', |
376 | - 'relbarbgcolor': '#203b6f', |
377 | - 'footerbgcolor': '#26437c', |
378 | - 'headtextcolor': '#203b6f', |
379 | - 'linkcolor': '#26437c', |
380 | - 'sidebarlinkcolor': '#ceceff' |
381 | -} |
382 | +#html_theme_options = {} |
383 | |
384 | # Add any paths that contain custom themes here, relative to this directory. |
385 | #html_theme_path = [] |
386 | |
387 | # The name for this set of Sphinx documents. If None, it defaults to |
388 | # "<project> v<release> documentation". |
389 | -html_title = 'OpenLP 2.0 Developer API' |
390 | +#html_title = None |
391 | |
392 | # A shorter title for the navigation bar. Default is the same as html_title. |
393 | #html_short_title = None |
394 | @@ -136,6 +143,11 @@ |
395 | # so a file named "default.css" will overwrite the builtin "default.css". |
396 | html_static_path = ['_static'] |
397 | |
398 | +# Add any extra paths that contain custom files (such as robots.txt or |
399 | +# .htaccess) here, relative to this directory. These files are copied |
400 | +# directly to the root of the documentation. |
401 | +#html_extra_path = [] |
402 | + |
403 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, |
404 | # using the given strftime format. |
405 | #html_last_updated_fmt = '%b %d, %Y' |
406 | @@ -152,7 +164,7 @@ |
407 | #html_additional_pages = {} |
408 | |
409 | # If false, no module index is generated. |
410 | -#html_use_modindex = True |
411 | +#html_domain_indices = True |
412 | |
413 | # If false, no index is generated. |
414 | #html_use_index = True |
415 | @@ -163,31 +175,43 @@ |
416 | # If true, links to the reST sources are added to the pages. |
417 | #html_show_sourcelink = True |
418 | |
419 | +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. |
420 | +#html_show_sphinx = True |
421 | + |
422 | +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. |
423 | +#html_show_copyright = True |
424 | + |
425 | # If true, an OpenSearch description file will be output, and all pages will |
426 | # contain a <link> tag referring to it. The value of this option must be the |
427 | # base URL from which the finished HTML is served. |
428 | #html_use_opensearch = '' |
429 | |
430 | -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). |
431 | -#html_file_suffix = '' |
432 | +# This is the file name suffix for HTML files (e.g. ".xhtml"). |
433 | +#html_file_suffix = None |
434 | |
435 | # Output file base name for HTML help builder. |
436 | -htmlhelp_basename = 'OpenLP-2.0-api' |
437 | - |
438 | - |
439 | -# -- Options for LaTeX output -------------------------------------------------- |
440 | - |
441 | -# The paper size ('letter' or 'a4'). |
442 | -#latex_paper_size = 'letter' |
443 | +htmlhelp_basename = 'OpenLP-api' |
444 | + |
445 | + |
446 | +# -- Options for LaTeX output --------------------------------------------- |
447 | + |
448 | +latex_elements = { |
449 | +# The paper size ('letterpaper' or 'a4paper'). |
450 | +#'papersize': 'letterpaper', |
451 | |
452 | # The font size ('10pt', '11pt' or '12pt'). |
453 | -#latex_font_size = '10pt' |
454 | +#'pointsize': '10pt', |
455 | + |
456 | +# Additional stuff for the LaTeX preamble. |
457 | +#'preamble': '', |
458 | +} |
459 | |
460 | # Grouping the document tree into LaTeX files. List of tuples |
461 | -# (source start file, target name, title, author, documentclass [howto/manual]). |
462 | +# (source start file, target name, title, |
463 | +# author, documentclass [howto, manual, or own class]). |
464 | latex_documents = [ |
465 | - ('index', 'OpenLP.tex', u'OpenLP 2.0 Developer API', |
466 | - u'Raoul Snyman', 'manual'), |
467 | + ('index', 'OpenLP.tex', 'OpenLP Developer API', |
468 | + 'Raoul Snyman', 'manual'), |
469 | ] |
470 | |
471 | # The name of an image file (relative to this directory) to place at the top of |
472 | @@ -198,11 +222,131 @@ |
473 | # not chapters. |
474 | #latex_use_parts = False |
475 | |
476 | -# Additional stuff for the LaTeX preamble. |
477 | -#latex_preamble = '' |
478 | +# If true, show page references after internal links. |
479 | +#latex_show_pagerefs = False |
480 | + |
481 | +# If true, show URL addresses after external links. |
482 | +#latex_show_urls = False |
483 | |
484 | # Documents to append as an appendix to all manuals. |
485 | #latex_appendices = [] |
486 | |
487 | # If false, no module index is generated. |
488 | -#latex_use_modindex = True |
489 | +#latex_domain_indices = True |
490 | + |
491 | + |
492 | +# -- Options for manual page output --------------------------------------- |
493 | + |
494 | +# One entry per manual page. List of tuples |
495 | +# (source start file, name, description, authors, manual section). |
496 | +man_pages = [ |
497 | + ('index', 'openlp', 'OpenLP Developer API', |
498 | + ['Raoul Snyman'], 1) |
499 | +] |
500 | + |
501 | +# If true, show URL addresses after external links. |
502 | +#man_show_urls = False |
503 | + |
504 | + |
505 | +# -- Options for Texinfo output ------------------------------------------- |
506 | + |
507 | +# Grouping the document tree into Texinfo files. List of tuples |
508 | +# (source start file, target name, title, author, |
509 | +# dir menu entry, description, category) |
510 | +texinfo_documents = [ |
511 | + ('index', 'OpenLP', 'OpenLP Developer API', |
512 | + 'Raoul Snyman', 'OpenLP', 'One line description of project.', |
513 | + 'Miscellaneous'), |
514 | +] |
515 | + |
516 | +# Documents to append as an appendix to all manuals. |
517 | +#texinfo_appendices = [] |
518 | + |
519 | +# If false, no module index is generated. |
520 | +#texinfo_domain_indices = True |
521 | + |
522 | +# How to display URL addresses: 'footnote', 'no', or 'inline'. |
523 | +#texinfo_show_urls = 'footnote' |
524 | + |
525 | +# If true, do not generate a @detailmenu in the "Top" node's menu. |
526 | +#texinfo_no_detailmenu = False |
527 | + |
528 | + |
529 | +# -- Options for Epub output ---------------------------------------------- |
530 | + |
531 | +# Bibliographic Dublin Core info. |
532 | +epub_title = 'OpenLP' |
533 | +epub_author = 'Raoul Snyman' |
534 | +epub_publisher = 'Raoul Snyman' |
535 | +epub_copyright = '2004-2015, Raoul Snyman' |
536 | + |
537 | +# The basename for the epub file. It defaults to the project name. |
538 | +#epub_basename = 'OpenLP' |
539 | + |
540 | +# The HTML theme for the epub output. Since the default themes are not optimized |
541 | +# for small screen space, using the same theme for HTML and epub output is |
542 | +# usually not wise. This defaults to 'epub', a theme designed to save visual |
543 | +# space. |
544 | +#epub_theme = 'epub' |
545 | + |
546 | +# The language of the text. It defaults to the language option |
547 | +# or en if the language is not set. |
548 | +#epub_language = '' |
549 | + |
550 | +# The scheme of the identifier. Typical schemes are ISBN or URL. |
551 | +#epub_scheme = '' |
552 | + |
553 | +# The unique identifier of the text. This can be a ISBN number |
554 | +# or the project homepage. |
555 | +#epub_identifier = '' |
556 | + |
557 | +# A unique identification for the text. |
558 | +#epub_uid = '' |
559 | + |
560 | +# A tuple containing the cover image and cover page html template filenames. |
561 | +#epub_cover = () |
562 | + |
563 | +# A sequence of (type, uri, title) tuples for the guide element of content.opf. |
564 | +#epub_guide = () |
565 | + |
566 | +# HTML files that should be inserted before the pages created by sphinx. |
567 | +# The format is a list of tuples containing the path and title. |
568 | +#epub_pre_files = [] |
569 | + |
570 | +# HTML files shat should be inserted after the pages created by sphinx. |
571 | +# The format is a list of tuples containing the path and title. |
572 | +#epub_post_files = [] |
573 | + |
574 | +# A list of files that should not be packed into the epub file. |
575 | +epub_exclude_files = ['search.html'] |
576 | + |
577 | +# The depth of the table of contents in toc.ncx. |
578 | +#epub_tocdepth = 3 |
579 | + |
580 | +# Allow duplicate toc entries. |
581 | +#epub_tocdup = True |
582 | + |
583 | +# Choose between 'default' and 'includehidden'. |
584 | +#epub_tocscope = 'default' |
585 | + |
586 | +# Fix unsupported image types using the PIL. |
587 | +#epub_fix_images = False |
588 | + |
589 | +# Scale large images. |
590 | +#epub_max_image_width = 0 |
591 | + |
592 | +# How to display URL addresses: 'footnote', 'no', or 'inline'. |
593 | +#epub_show_urls = 'inline' |
594 | + |
595 | +# If false, no index is generated. |
596 | +#epub_use_index = True |
597 | + |
598 | + |
599 | +# Example configuration for intersphinx: refer to the Python standard library. |
600 | +intersphinx_mapping = {'python': ('http://docs.python.org/3.4', None)} |
601 | + |
602 | +autosummary_generate = True |
603 | + |
604 | +autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance'] |
605 | + |
606 | +autodoc_mock_imports = ['pyodbc', 'uno', 'PyQt4.phonon', 'com.sun.star.connection', 'com.sun.star.beans'] |
607 | |
608 | === removed directory 'api/source/core' |
609 | === removed file 'api/source/core/index.rst' |
610 | --- api/source/core/index.rst 2012-06-13 17:34:02 +0000 |
611 | +++ api/source/core/index.rst 1970-01-01 00:00:00 +0000 |
612 | @@ -1,18 +0,0 @@ |
613 | -.. _core-index: |
614 | - |
615 | -Core Application |
616 | -================ |
617 | - |
618 | -This is the core of the OpenLP application. Anything that is not a plugin is |
619 | -stored in the :mod:`~openlp.core` module. |
620 | - |
621 | -.. toctree:: |
622 | - :maxdepth: 2 |
623 | - |
624 | - lib |
625 | - theme |
626 | - ui |
627 | - utils |
628 | - |
629 | -.. automodule:: openlp.core |
630 | - :members: |
631 | |
632 | === removed file 'api/source/core/lib.rst' |
633 | --- api/source/core/lib.rst 2011-12-26 13:54:48 +0000 |
634 | +++ api/source/core/lib.rst 1970-01-01 00:00:00 +0000 |
635 | @@ -1,79 +0,0 @@ |
636 | -.. _core-lib: |
637 | - |
638 | -Object Library |
639 | -============== |
640 | - |
641 | -.. automodule:: openlp.core.lib |
642 | - :members: |
643 | - |
644 | -:mod:`Manager` |
645 | --------------------- |
646 | - |
647 | -.. autoclass:: openlp.core.lib.db.Manager |
648 | - :members: |
649 | - |
650 | -:mod:`EventReceiver` |
651 | --------------------- |
652 | - |
653 | -.. autoclass:: openlp.core.lib.eventreceiver.EventReceiver |
654 | - :members: |
655 | - |
656 | -:mod:`ListWidgetWithDnD` |
657 | ------------------------- |
658 | - |
659 | -.. autoclass:: openlp.core.lib.listwidgetwithdnd.ListWidgetWithDnD |
660 | - :members: |
661 | - |
662 | -:mod:`MediaManagerItem` |
663 | ------------------------ |
664 | - |
665 | -.. autoclass:: openlp.core.lib.mediamanageritem.MediaManagerItem |
666 | - :members: |
667 | - |
668 | -:mod:`Plugin` |
669 | -------------- |
670 | - |
671 | -.. autoclass:: openlp.core.lib.plugin.Plugin |
672 | - :members: |
673 | - |
674 | -:mod:`PluginManager` |
675 | --------------------- |
676 | - |
677 | -.. autoclass:: openlp.core.lib.pluginmanager.PluginManager |
678 | - :members: |
679 | - |
680 | -:mod:`Renderer` |
681 | ---------------- |
682 | - |
683 | -.. autoclass:: openlp.core.lib.renderer.Renderer |
684 | - :members: |
685 | - |
686 | -:mod:`SearchEdit` |
687 | --------------------- |
688 | - |
689 | -.. autoclass:: openlp.core.lib.searchedit.SearchEdit |
690 | - :members: |
691 | - |
692 | -:mod:`ServiceItem` |
693 | ------------------- |
694 | - |
695 | -.. autoclass:: openlp.core.lib.serviceitem.ServiceItem |
696 | - :members: |
697 | - |
698 | -:mod:`SettingsTab` |
699 | ------------------- |
700 | - |
701 | -.. autoclass:: openlp.core.lib.settingstab.SettingsTab |
702 | - :members: |
703 | - |
704 | -:mod:`OpenLPToolbar` |
705 | --------------------- |
706 | - |
707 | -.. autoclass:: openlp.core.lib.toolbar.OpenLPToolbar |
708 | - :members: |
709 | - |
710 | -:mod:`UiStrings` |
711 | --------------------- |
712 | - |
713 | -.. autoclass:: openlp.core.lib.ui.UiStrings |
714 | - :members: |
715 | \ No newline at end of file |
716 | |
717 | === removed file 'api/source/core/theme.rst' |
718 | --- api/source/core/theme.rst 2011-05-08 21:22:30 +0000 |
719 | +++ api/source/core/theme.rst 1970-01-01 00:00:00 +0000 |
720 | @@ -1,10 +0,0 @@ |
721 | -.. _core-theme: |
722 | - |
723 | -Theme Function Library |
724 | -====================== |
725 | - |
726 | -.. automodule:: openlp.core.theme |
727 | - :members: |
728 | - |
729 | -.. autoclass:: openlp.core.theme.theme.Theme |
730 | - :members: |
731 | |
732 | === removed file 'api/source/core/ui.rst' |
733 | --- api/source/core/ui.rst 2011-12-26 13:54:48 +0000 |
734 | +++ api/source/core/ui.rst 1970-01-01 00:00:00 +0000 |
735 | @@ -1,30 +0,0 @@ |
736 | -.. _core-ui: |
737 | - |
738 | -User Interface |
739 | -============== |
740 | - |
741 | -.. automodule:: openlp.core.ui |
742 | - |
743 | -Main Windows |
744 | ------------- |
745 | - |
746 | -.. autoclass:: openlp.core.ui.mainwindow.MainWindow |
747 | - :members: |
748 | - |
749 | -.. autoclass:: openlp.core.ui.maindisplay.MainDisplay |
750 | - :members: |
751 | - |
752 | -Managers |
753 | --------- |
754 | - |
755 | -.. autoclass:: openlp.core.ui.slidecontroller.SlideController |
756 | - :members: |
757 | - |
758 | -.. autoclass:: openlp.core.ui.servicemanager.ServiceManager |
759 | - :members: |
760 | - |
761 | -.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager |
762 | - :members: |
763 | - |
764 | -.. autoclass:: openlp.core.ui.thememanager.ThemeManager |
765 | - :members: |
766 | |
767 | === removed file 'api/source/core/utils.rst' |
768 | --- api/source/core/utils.rst 2011-05-08 21:22:30 +0000 |
769 | +++ api/source/core/utils.rst 1970-01-01 00:00:00 +0000 |
770 | @@ -1,7 +0,0 @@ |
771 | -.. _core-utils: |
772 | - |
773 | -Utilities |
774 | -========= |
775 | - |
776 | -.. automodule:: openlp.core.utils |
777 | - :members: |
778 | |
779 | === added directory 'api/source/doc' |
780 | === added directory 'api/source/doc/mainwindows' |
781 | === added file 'api/source/doc/mainwindows/maindisplay.rst' |
782 | --- api/source/doc/mainwindows/maindisplay.rst 1970-01-01 00:00:00 +0000 |
783 | +++ api/source/doc/mainwindows/maindisplay.rst 2015-09-09 01:52:05 +0000 |
784 | @@ -0,0 +1,6 @@ |
785 | +Main Display |
786 | +------------ |
787 | + |
788 | +.. autoclass:: openlp.core.ui.maindisplay.MainDisplay |
789 | + :members: |
790 | + :noindex: |
791 | |
792 | === added file 'api/source/doc/mainwindows/mainwindow.rst' |
793 | --- api/source/doc/mainwindows/mainwindow.rst 1970-01-01 00:00:00 +0000 |
794 | +++ api/source/doc/mainwindows/mainwindow.rst 2015-09-09 01:52:05 +0000 |
795 | @@ -0,0 +1,6 @@ |
796 | +Main Window |
797 | +----------- |
798 | + |
799 | +.. autoclass:: openlp.core.ui.mainwindow.MainWindow |
800 | + :members: |
801 | + :noindex: |
802 | |
803 | === added directory 'api/source/doc/managers' |
804 | === added file 'api/source/doc/managers/mediadockmanager.rst' |
805 | --- api/source/doc/managers/mediadockmanager.rst 1970-01-01 00:00:00 +0000 |
806 | +++ api/source/doc/managers/mediadockmanager.rst 2015-09-09 01:52:05 +0000 |
807 | @@ -0,0 +1,6 @@ |
808 | +Media Dock Manager |
809 | +------------------ |
810 | + |
811 | +.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager |
812 | + :members: |
813 | + :noindex: |
814 | |
815 | === added file 'api/source/doc/managers/servicemanager.rst' |
816 | --- api/source/doc/managers/servicemanager.rst 1970-01-01 00:00:00 +0000 |
817 | +++ api/source/doc/managers/servicemanager.rst 2015-09-09 01:52:05 +0000 |
818 | @@ -0,0 +1,6 @@ |
819 | +Service Manager |
820 | +--------------- |
821 | + |
822 | +.. autoclass:: openlp.core.ui.servicemanager.ServiceManager |
823 | + :members: |
824 | + :noindex: |
825 | |
826 | === added file 'api/source/doc/managers/slidecontroller.rst' |
827 | --- api/source/doc/managers/slidecontroller.rst 1970-01-01 00:00:00 +0000 |
828 | +++ api/source/doc/managers/slidecontroller.rst 2015-09-09 01:52:05 +0000 |
829 | @@ -0,0 +1,6 @@ |
830 | +Slide Controller |
831 | +---------------- |
832 | + |
833 | +.. autoclass:: openlp.core.ui.slidecontroller.SlideController |
834 | + :members: |
835 | + :noindex: |
836 | |
837 | === added file 'api/source/doc/managers/thememanager.rst' |
838 | --- api/source/doc/managers/thememanager.rst 1970-01-01 00:00:00 +0000 |
839 | +++ api/source/doc/managers/thememanager.rst 2015-09-09 01:52:05 +0000 |
840 | @@ -0,0 +1,6 @@ |
841 | +Theme Manager |
842 | +------------- |
843 | + |
844 | +.. autoclass:: openlp.core.ui.thememanager.ThemeManager |
845 | + :members: |
846 | + :noindex: |
847 | |
848 | === added file 'api/source/doc/ui.rst' |
849 | --- api/source/doc/ui.rst 1970-01-01 00:00:00 +0000 |
850 | +++ api/source/doc/ui.rst 2015-09-09 01:52:05 +0000 |
851 | @@ -0,0 +1,20 @@ |
852 | +UI Documentation |
853 | +================ |
854 | + |
855 | +Main Windows |
856 | +------------ |
857 | + |
858 | +.. toctree:: |
859 | + :glob: |
860 | + :maxdepth: 2 |
861 | + |
862 | + mainwindows/* |
863 | + |
864 | +Managers |
865 | +-------- |
866 | + |
867 | +.. toctree:: |
868 | + :glob: |
869 | + :maxdepth: 2 |
870 | + |
871 | + managers/* |
872 | |
873 | === modified file 'api/source/index.rst' |
874 | --- api/source/index.rst 2011-05-08 21:22:30 +0000 |
875 | +++ api/source/index.rst 2015-09-09 01:52:05 +0000 |
876 | @@ -1,22 +1,30 @@ |
877 | .. OpenLP documentation master file, created by |
878 | - sphinx-quickstart on Fri Jul 10 17:20:40 2009. |
879 | + sphinx-quickstart on Mon Jun 16 15:48:38 2014. |
880 | You can adapt this file completely to your liking, but it should at least |
881 | contain the root `toctree` directive. |
882 | |
883 | Welcome |
884 | ======= |
885 | |
886 | -Welcome to the OpenLP 2.0 API Documentation! In here you will find all |
887 | +Welcome to the OpenLP 2.2 API Documentation! In here you will find all |
888 | information relating to OpenLP's core classes, core plugins, and anything else |
889 | deemed necessary or interesting by the developers. |
890 | |
891 | -Contents: |
892 | - |
893 | -.. toctree:: |
894 | - :maxdepth: 2 |
895 | - |
896 | - core/index |
897 | - plugins/index |
898 | +Documentation: |
899 | + |
900 | +.. toctree:: |
901 | + :glob: |
902 | + :maxdepth: 2 |
903 | + |
904 | + doc/* |
905 | + |
906 | +API Documentation: |
907 | + |
908 | +.. toctree:: |
909 | + :glob: |
910 | + :maxdepth: 2 |
911 | + |
912 | + api/* |
913 | |
914 | Indices and tables |
915 | ================== |
916 | |
917 | === removed directory 'api/source/plugins' |
918 | === removed file 'api/source/plugins/alerts.rst' |
919 | --- api/source/plugins/alerts.rst 2011-05-08 21:22:30 +0000 |
920 | +++ api/source/plugins/alerts.rst 1970-01-01 00:00:00 +0000 |
921 | @@ -1,31 +0,0 @@ |
922 | -.. _plugins-alerts: |
923 | - |
924 | -Alerts Plugin |
925 | -============= |
926 | - |
927 | -.. automodule:: openlp.plugins.alerts |
928 | - :members: |
929 | - |
930 | -Plugin Class |
931 | ------------- |
932 | - |
933 | -.. autoclass:: openlp.plugins.alerts.alertsplugin.AlertsPlugin |
934 | - :members: |
935 | - |
936 | -Forms |
937 | ------ |
938 | - |
939 | -.. automodule:: openlp.plugins.alerts.forms |
940 | - :members: |
941 | - |
942 | -.. autoclass:: openlp.plugins.alerts.forms.alertform.AlertForm |
943 | - :members: |
944 | - |
945 | -Helper Classes & Functions |
946 | --------------------------- |
947 | - |
948 | -.. automodule:: openlp.plugins.alerts.lib |
949 | - :members: |
950 | - |
951 | -.. automodule:: openlp.plugins.alerts.lib.db |
952 | - :members: |
953 | |
954 | === removed file 'api/source/plugins/bibles.rst' |
955 | --- api/source/plugins/bibles.rst 2011-05-08 21:22:30 +0000 |
956 | +++ api/source/plugins/bibles.rst 1970-01-01 00:00:00 +0000 |
957 | @@ -1,55 +0,0 @@ |
958 | -.. _plugins-bibles: |
959 | - |
960 | -Bibles Plugin |
961 | -============= |
962 | - |
963 | -.. automodule:: openlp.plugins.bibles |
964 | - :members: |
965 | - |
966 | -Plugin Class |
967 | ------------- |
968 | - |
969 | -.. autoclass:: openlp.plugins.bibles.bibleplugin.BiblePlugin |
970 | - :members: |
971 | - |
972 | -Forms |
973 | ------ |
974 | - |
975 | -.. automodule:: openlp.plugins.bibles.forms |
976 | - :members: |
977 | - |
978 | -.. autoclass:: openlp.plugins.bibles.forms.bibleimportform.BibleImportForm |
979 | - :members: |
980 | - |
981 | -Helper Classes & Functions |
982 | --------------------------- |
983 | - |
984 | -.. automodule:: openlp.plugins.bibles.lib |
985 | - :members: |
986 | - |
987 | -.. automodule:: openlp.plugins.bibles.lib.db |
988 | - :members: |
989 | - |
990 | -.. automodule:: openlp.plugins.bibles.lib.biblestab |
991 | - :members: |
992 | - |
993 | -.. automodule:: openlp.plugins.bibles.lib.manager |
994 | - :members: |
995 | - |
996 | -.. automodule:: openlp.plugins.bibles.lib.mediaitem |
997 | - :members: |
998 | - |
999 | -Bible Importers |
1000 | ---------------- |
1001 | - |
1002 | -.. automodule:: openlp.plugins.bibles.lib.csvbible |
1003 | - :members: |
1004 | - |
1005 | -.. automodule:: openlp.plugins.bibles.lib.http |
1006 | - :members: |
1007 | - |
1008 | -.. automodule:: openlp.plugins.bibles.lib.osis |
1009 | - :members: |
1010 | - |
1011 | -.. automodule:: openlp.plugins.bibles.lib.opensong |
1012 | - :members: |
1013 | |
1014 | === removed file 'api/source/plugins/custom.rst' |
1015 | --- api/source/plugins/custom.rst 2011-05-08 21:22:30 +0000 |
1016 | +++ api/source/plugins/custom.rst 1970-01-01 00:00:00 +0000 |
1017 | @@ -1,34 +0,0 @@ |
1018 | -.. _plugins-custom: |
1019 | - |
1020 | -Custom Slides Plugin |
1021 | -==================== |
1022 | - |
1023 | -.. automodule:: openlp.plugins.custom |
1024 | - :members: |
1025 | - |
1026 | -Plugin Class |
1027 | ------------- |
1028 | - |
1029 | -.. autoclass:: openlp.plugins.custom.customplugin.CustomPlugin |
1030 | - :members: |
1031 | - |
1032 | -Forms |
1033 | ------ |
1034 | - |
1035 | -.. automodule:: openlp.plugins.custom.forms |
1036 | - :members: |
1037 | - |
1038 | -.. autoclass:: openlp.plugins.custom.forms.editcustomform.EditCustomForm |
1039 | - :members: |
1040 | - |
1041 | -.. autoclass:: openlp.plugins.custom.forms.editcustomslideform.EditCustomSlideForm |
1042 | - :members: |
1043 | - |
1044 | -Helper Classes & Functions |
1045 | --------------------------- |
1046 | - |
1047 | -.. automodule:: openlp.plugins.custom.lib |
1048 | - :members: |
1049 | - |
1050 | -.. automodule:: openlp.plugins.custom.lib.mediaitem |
1051 | - :members: |
1052 | |
1053 | === removed file 'api/source/plugins/images.rst' |
1054 | --- api/source/plugins/images.rst 2011-05-08 21:22:30 +0000 |
1055 | +++ api/source/plugins/images.rst 1970-01-01 00:00:00 +0000 |
1056 | @@ -1,22 +0,0 @@ |
1057 | -.. _plugins-images: |
1058 | - |
1059 | -Images Plugin |
1060 | -============= |
1061 | - |
1062 | -.. automodule:: openlp.plugins.images |
1063 | - :members: |
1064 | - |
1065 | -Plugin Class |
1066 | ------------- |
1067 | - |
1068 | -.. autoclass:: openlp.plugins.images.imageplugin.ImagePlugin |
1069 | - :members: |
1070 | - |
1071 | -Helper Classes & Functions |
1072 | --------------------------- |
1073 | - |
1074 | -.. automodule:: openlp.plugins.images.lib |
1075 | - :members: |
1076 | - |
1077 | -.. automodule:: openlp.plugins.images.lib.mediaitem |
1078 | - :members: |
1079 | |
1080 | === removed file 'api/source/plugins/index.rst' |
1081 | --- api/source/plugins/index.rst 2011-05-08 21:22:30 +0000 |
1082 | +++ api/source/plugins/index.rst 1970-01-01 00:00:00 +0000 |
1083 | @@ -1,20 +0,0 @@ |
1084 | -.. _plugins-index: |
1085 | - |
1086 | -Plugins |
1087 | -======= |
1088 | - |
1089 | -.. automodule:: openlp.plugins |
1090 | - :members: |
1091 | - |
1092 | -.. toctree:: |
1093 | - :maxdepth: 2 |
1094 | - |
1095 | - songs |
1096 | - bibles |
1097 | - presentations |
1098 | - media |
1099 | - images |
1100 | - custom |
1101 | - remotes |
1102 | - songusage |
1103 | - alerts |
1104 | |
1105 | === removed file 'api/source/plugins/media.rst' |
1106 | --- api/source/plugins/media.rst 2012-06-13 17:34:02 +0000 |
1107 | +++ api/source/plugins/media.rst 1970-01-01 00:00:00 +0000 |
1108 | @@ -1,22 +0,0 @@ |
1109 | -.. _plugins-media: |
1110 | - |
1111 | -Media Plugin |
1112 | -============ |
1113 | - |
1114 | -.. automodule:: openlp.plugins.media |
1115 | - :members: |
1116 | - |
1117 | -Plugin Class |
1118 | ------------- |
1119 | - |
1120 | -.. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin |
1121 | - :members: |
1122 | - |
1123 | -Helper Classes & Functions |
1124 | --------------------------- |
1125 | - |
1126 | -.. automodule:: openlp.plugins.media.lib |
1127 | - :members: |
1128 | - |
1129 | -.. automodule:: openlp.plugins.media.lib.mediaitem |
1130 | - :members: |
1131 | |
1132 | === removed file 'api/source/plugins/presentations.rst' |
1133 | --- api/source/plugins/presentations.rst 2011-05-08 21:22:30 +0000 |
1134 | +++ api/source/plugins/presentations.rst 1970-01-01 00:00:00 +0000 |
1135 | @@ -1,40 +0,0 @@ |
1136 | -.. _plugins-presentations: |
1137 | - |
1138 | -Presentations Plugin |
1139 | -==================== |
1140 | - |
1141 | -Plugin Class |
1142 | ------------- |
1143 | - |
1144 | -.. autoclass:: openlp.plugins.presentations.presentationplugin.PresentationPlugin |
1145 | - :members: |
1146 | - |
1147 | -Helper Classes & Functions |
1148 | --------------------------- |
1149 | - |
1150 | -.. automodule:: openlp.plugins.presentations.lib |
1151 | - :members: |
1152 | - |
1153 | -.. automodule:: openlp.plugins.presentations.lib.mediaitem |
1154 | - :members: |
1155 | - |
1156 | -.. automodule:: openlp.plugins.presentations.lib.presentationtab |
1157 | - :members: |
1158 | - |
1159 | -.. automodule:: openlp.plugins.presentations.lib.messagelistener |
1160 | - :members: |
1161 | - |
1162 | -.. automodule:: openlp.plugins.presentations.lib.presentationcontroller |
1163 | - :members: |
1164 | - |
1165 | -Presentation Application Controllers |
1166 | ------------------------------------- |
1167 | - |
1168 | -.. automodule:: openlp.plugins.presentations.lib.impresscontroller |
1169 | - :members: |
1170 | - |
1171 | -.. automodule:: openlp.plugins.presentations.lib.pptviewcontroller |
1172 | - :members: |
1173 | - |
1174 | -.. automodule:: openlp.plugins.presentations.lib.powerpointcontroller |
1175 | - :members: |
1176 | |
1177 | === removed file 'api/source/plugins/remotes.rst' |
1178 | --- api/source/plugins/remotes.rst 2011-05-08 21:22:30 +0000 |
1179 | +++ api/source/plugins/remotes.rst 1970-01-01 00:00:00 +0000 |
1180 | @@ -1,25 +0,0 @@ |
1181 | -.. _plugins-remotes: |
1182 | - |
1183 | -Remotes Plugin |
1184 | -============== |
1185 | - |
1186 | -.. automodule:: openlp.plugins.remotes |
1187 | - :members: |
1188 | - |
1189 | -Plugin Class |
1190 | ------------- |
1191 | - |
1192 | -.. autoclass:: openlp.plugins.remotes.remoteplugin.RemotesPlugin |
1193 | - :members: |
1194 | - |
1195 | -Helper Classes & Functions |
1196 | --------------------------- |
1197 | - |
1198 | -.. automodule:: openlp.plugins.remotes.lib |
1199 | - :members: |
1200 | - |
1201 | -.. autoclass:: openlp.plugins.remotes.lib.httpserver.HttpConnection |
1202 | - :members: |
1203 | - |
1204 | -.. autoclass:: openlp.plugins.remotes.lib.httpserver.HttpResponse |
1205 | - :members: |
1206 | |
1207 | === removed file 'api/source/plugins/songs.rst' |
1208 | --- api/source/plugins/songs.rst 2012-06-15 06:01:35 +0000 |
1209 | +++ api/source/plugins/songs.rst 1970-01-01 00:00:00 +0000 |
1210 | @@ -1,97 +0,0 @@ |
1211 | -.. _plugins-songs: |
1212 | - |
1213 | -Songs Plugin |
1214 | -============ |
1215 | - |
1216 | -.. automodule:: openlp.plugins.songs |
1217 | - :members: |
1218 | - |
1219 | -Plugin Class |
1220 | ------------- |
1221 | - |
1222 | -.. autoclass:: openlp.plugins.songs.songsplugin.SongsPlugin |
1223 | - :members: |
1224 | - |
1225 | -Forms |
1226 | ------ |
1227 | - |
1228 | -.. automodule:: openlp.plugins.songs.forms |
1229 | - :members: |
1230 | - |
1231 | -.. autoclass:: openlp.plugins.songs.forms.authorsform.AuthorsForm |
1232 | - :members: |
1233 | - |
1234 | -.. autoclass:: openlp.plugins.songs.forms.editsongform.EditSongForm |
1235 | - :members: |
1236 | - |
1237 | -.. autoclass:: openlp.plugins.songs.forms.editverseform.EditVerseForm |
1238 | - :members: |
1239 | - |
1240 | -.. autoclass:: openlp.plugins.songs.forms.songbookform.SongBookForm |
1241 | - :members: |
1242 | - |
1243 | -.. autoclass:: openlp.plugins.songs.forms.songimportform.SongImportForm |
1244 | - :members: |
1245 | - |
1246 | -.. autoclass:: openlp.plugins.songs.forms.songmaintenanceform.SongMaintenanceForm |
1247 | - :members: |
1248 | - |
1249 | -.. autoclass:: openlp.plugins.songs.forms.topicsform.TopicsForm |
1250 | - :members: |
1251 | - |
1252 | -Helper Classes & Functions |
1253 | --------------------------- |
1254 | - |
1255 | -.. automodule:: openlp.plugins.songs.lib |
1256 | - :members: |
1257 | - |
1258 | -.. automodule:: openlp.plugins.songs.lib.db |
1259 | - :members: |
1260 | - |
1261 | -.. automodule:: openlp.plugins.songs.lib.mediaitem |
1262 | - :members: |
1263 | - |
1264 | -.. automodule:: openlp.plugins.songs.lib.songimport |
1265 | - :members: |
1266 | - |
1267 | -.. automodule:: openlp.plugins.songs.lib.songstab |
1268 | - :members: |
1269 | - |
1270 | -.. automodule:: openlp.plugins.songs.lib.xml |
1271 | - :members: |
1272 | - |
1273 | -.. automodule:: openlp.plugins.songs.lib.upgrade |
1274 | - :members: |
1275 | - |
1276 | -Song Importers |
1277 | --------------- |
1278 | - |
1279 | -.. automodule:: openlp.plugins.songs.lib.cclifileimport |
1280 | - :members: |
1281 | - |
1282 | -.. automodule:: openlp.plugins.songs.lib.ewimport |
1283 | - :members: |
1284 | - |
1285 | -.. autoclass:: openlp.plugins.songs.lib.ewimport.FieldDescEntry |
1286 | - :members: |
1287 | - |
1288 | -.. automodule:: openlp.plugins.songs.lib.olp1import |
1289 | - :members: |
1290 | - |
1291 | -.. automodule:: openlp.plugins.songs.lib.olpimport |
1292 | - :members: |
1293 | - |
1294 | -.. automodule:: openlp.plugins.songs.lib.oooimport |
1295 | - :members: |
1296 | - |
1297 | -.. automodule:: openlp.plugins.songs.lib.opensongimport |
1298 | - :members: |
1299 | - |
1300 | -.. automodule:: openlp.plugins.songs.lib.sofimport |
1301 | - :members: |
1302 | - |
1303 | -.. automodule:: openlp.plugins.songs.lib.songbeamerimport |
1304 | - :members: |
1305 | - |
1306 | -.. automodule:: openlp.plugins.songs.lib.wowimport |
1307 | - :members: |
1308 | |
1309 | === removed file 'api/source/plugins/songusage.rst' |
1310 | --- api/source/plugins/songusage.rst 2011-05-08 21:22:30 +0000 |
1311 | +++ api/source/plugins/songusage.rst 1970-01-01 00:00:00 +0000 |
1312 | @@ -1,34 +0,0 @@ |
1313 | -.. _plugins-songusage: |
1314 | - |
1315 | -Song Usage Plugin |
1316 | -================= |
1317 | - |
1318 | -.. automodule:: openlp.plugins.songusage |
1319 | - :members: |
1320 | - |
1321 | -Plugin Class |
1322 | ------------- |
1323 | - |
1324 | -.. autoclass:: openlp.plugins.songusage.songusageplugin.SongUsagePlugin |
1325 | - :members: |
1326 | - |
1327 | -Forms |
1328 | ------ |
1329 | - |
1330 | -.. automodule:: openlp.plugins.songusage.forms |
1331 | - :members: |
1332 | - |
1333 | -.. autoclass:: openlp.plugins.songusage.forms.songusagedeleteform.SongUsageDeleteForm |
1334 | - :members: |
1335 | - |
1336 | -.. autoclass:: openlp.plugins.songusage.forms.songusagedetailform.SongUsageDetailForm |
1337 | - :members: |
1338 | - |
1339 | -Helper Classes & Functions |
1340 | --------------------------- |
1341 | - |
1342 | -.. automodule:: openlp.plugins.songusage.lib |
1343 | - :members: |
1344 | - |
1345 | -.. automodule:: openlp.plugins.songusage.lib.db |
1346 | - :members: |
1347 | |
1348 | === added file 'api/source/scan.py' |
1349 | --- api/source/scan.py 1970-01-01 00:00:00 +0000 |
1350 | +++ api/source/scan.py 2015-09-09 01:52:05 +0000 |
1351 | @@ -0,0 +1,120 @@ |
1352 | +#!/usr/bin/env python3 |
1353 | +# -*- coding: utf-8 -*- |
1354 | + |
1355 | +import os |
1356 | +import sys |
1357 | +import shutil |
1358 | +from modulefinder import ModuleFinder |
1359 | +import pkgutil |
1360 | +import string |
1361 | +import multiprocessing |
1362 | + |
1363 | +PACKAGE_RST = string.Template("""$underline |
1364 | +$title |
1365 | +$underline |
1366 | + |
1367 | +.. toctree:: |
1368 | + :glob: |
1369 | + :maxdepth: 2 |
1370 | + |
1371 | + $title/* |
1372 | + |
1373 | +.. automodule:: $module |
1374 | +""") |
1375 | + |
1376 | +MODULE_RST = string.Template("""$underline |
1377 | +$title |
1378 | +$underline |
1379 | + |
1380 | +.. automodule:: $module |
1381 | +$exclude""") |
1382 | + |
1383 | + |
1384 | +def find_modules(importer, module, package): |
1385 | + if module.startswith('openlp'): |
1386 | + title = str(module.split('.')[-1]) |
1387 | + underline = str(len(title) * '=') |
1388 | + values = {'underline': underline, 'title': title, 'module': module} |
1389 | + path = os.path.join(find_modules.root_path, module.replace('.', os.path.sep) + '.rst') |
1390 | + if package: |
1391 | + with open(os.path.join(path), 'w+') as file: |
1392 | + file.write(PACKAGE_RST.substitute(values)) |
1393 | + else: |
1394 | + finder = ModuleFinder() |
1395 | + exclude = '' |
1396 | + try: |
1397 | + finder.run_script(os.path.join(importer.path, title + '.py')) |
1398 | + except ImportError: |
1399 | + print('Failed to import {0}{1}'.format(module, ' '*25)) |
1400 | + raise |
1401 | + except: |
1402 | + print('Failed in module {0}'.format(module)) |
1403 | + raise |
1404 | + for name in finder.modules.keys(): |
1405 | + if name.startswith('sqlalchemy'): |
1406 | + exclude = " :exclude-members: mapper, or_, and_\n" |
1407 | + values['exclude'] = exclude |
1408 | + with open(os.path.join(path), 'w+') as file: |
1409 | + file.write(MODULE_RST.substitute(values)) |
1410 | + find_modules.queue.put(module) |
1411 | + |
1412 | + |
1413 | +def find_modules_init(queue, root_path): |
1414 | + find_modules.queue = queue |
1415 | + find_modules.root_path = root_path |
1416 | + |
1417 | + |
1418 | +def progress(queue, number): |
1419 | + progress_percentage = 0 |
1420 | + while number > progress_percentage: |
1421 | + try: |
1422 | + module = queue.get(True, 5) |
1423 | + except queue.Empty: |
1424 | + break |
1425 | + percent = round((progress_percentage/number)*100) |
1426 | + sys.stdout.write('{0}% File: {1}{2}\r'.format(percent, module, ' '*25)) |
1427 | + sys.stdout.flush() |
1428 | + progress_percentage += 1 |
1429 | + sys.stdout.write('100%{0}\n'.format(' '*50)) |
1430 | + sys.stdout.flush() |
1431 | + |
1432 | + |
1433 | +def main(): |
1434 | + modules = [] |
1435 | + |
1436 | + path_to_code = os.path.abspath(os.path.join(os.path.split(__file__)[0], |
1437 | + '..', '..', '..', '..', 'openlp', 'trunk')) |
1438 | + if not os.path.exists(path_to_code): |
1439 | + print('Incorrect path to code, expecting "%s"' % path_to_code) |
1440 | + sys.exit(1) |
1441 | + |
1442 | + root_path = os.path.abspath(os.path.join(os.path.split(__file__)[0], 'api')) |
1443 | + |
1444 | + sys.path.insert(0, path_to_code) |
1445 | + |
1446 | + if os.path.isdir(root_path): |
1447 | + shutil.rmtree(root_path) |
1448 | + os.makedirs(root_path) |
1449 | + |
1450 | + pkg = pkgutil.walk_packages([path_to_code], onerror=print) |
1451 | + |
1452 | + for importer, module, package in pkg: |
1453 | + if module.startswith('openlp') and not module.endswith(('vendor', 'vlc')): |
1454 | + path = os.path.join(root_path, module.replace('.', os.path.sep)) |
1455 | + if package: |
1456 | + if not os.path.exists(path): |
1457 | + os.makedirs(path) |
1458 | + modules.append([importer, module, package]) |
1459 | + |
1460 | + del sys.path[0] |
1461 | + |
1462 | + queue = multiprocessing.Queue() |
1463 | + thread = multiprocessing.Process(target=progress, args=(queue, len(modules))) |
1464 | + thread.start() |
1465 | + pool = multiprocessing.Pool(None, find_modules_init, [queue, root_path]) |
1466 | + pool.starmap(find_modules, modules) |
1467 | + pool.close() |
1468 | + |
1469 | + |
1470 | +if __name__ == '__main__': |
1471 | + main() |
Do we still need some specific Details and the whole tree? If we have the whole tree that should be fine so we do not need MainDisplay / Window and some managers picked out.