Use script to auto generate OpenLP API documentation
This commit is contained in:
Jonathan Springer
parent
d667e37966
commit
8a8ac1d849
|
|
@ -1,3 +1,4 @@
|
|||
build
|
||||
.directory
|
||||
.idea/
|
||||
api/source/api
|
||||
|
|
|
|||
163
api/Makefile
163
api/Makefile
|
|
@ -5,84 +5,177 @@
|
|||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
PAPER =
|
||||
BUILDDIR = build
|
||||
|
||||
# User-friendly check for sphinx-build
|
||||
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
|
||||
$(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/)
|
||||
endif
|
||||
|
||||
# Internal variables.
|
||||
PAPEROPT_a4 = -D latex_paper_size=a4
|
||||
PAPEROPT_letter = -D latex_paper_size=letter
|
||||
ALLSPHINXOPTS = -d build/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
# the i18n builder cannot share the environment and doctrees with the others
|
||||
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
|
||||
|
||||
.PHONY: help clean html dirhtml pickle json htmlhelp qthelp latex changes linkcheck doctest
|
||||
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
|
||||
|
||||
help:
|
||||
@echo "Please use \`make <target>' where <target> is one of"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " html to make standalone HTML files"
|
||||
@echo " dirhtml to make HTML files named index.html in directories"
|
||||
@echo " singlehtml to make a single large HTML file"
|
||||
@echo " pickle to make pickle files"
|
||||
@echo " json to make JSON files"
|
||||
@echo " htmlhelp to make HTML files and a HTML help project"
|
||||
@echo " qthelp to make HTML files and a qthelp project"
|
||||
@echo " devhelp to make HTML files and a Devhelp project"
|
||||
@echo " epub to make an epub"
|
||||
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
|
||||
@echo " latexpdf to make LaTeX files and run them through pdflatex"
|
||||
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
|
||||
@echo " text to make text files"
|
||||
@echo " man to make manual pages"
|
||||
@echo " texinfo to make Texinfo files"
|
||||
@echo " info to make Texinfo files and run them through makeinfo"
|
||||
@echo " gettext to make PO message catalogs"
|
||||
@echo " changes to make an overview of all changed/added/deprecated items"
|
||||
@echo " xml to make Docutils-native XML files"
|
||||
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
|
||||
@echo " linkcheck to check all external links for integrity"
|
||||
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
|
||||
@echo " scan to generate .rst for the OpenLP API from OpenLP's source"
|
||||
|
||||
clean:
|
||||
-rm -rf build/*
|
||||
rm -rf $(BUILDDIR)/*
|
||||
|
||||
html:
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) build/html
|
||||
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in build/html."
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
|
||||
|
||||
dirhtml:
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) build/dirhtml
|
||||
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML pages are in build/dirhtml."
|
||||
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
|
||||
|
||||
singlehtml:
|
||||
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
|
||||
@echo
|
||||
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
|
||||
|
||||
pickle:
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) build/pickle
|
||||
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
|
||||
@echo
|
||||
@echo "Build finished; now you can process the pickle files."
|
||||
|
||||
json:
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) build/json
|
||||
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
|
||||
@echo
|
||||
@echo "Build finished; now you can process the JSON files."
|
||||
|
||||
htmlhelp:
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) build/htmlhelp
|
||||
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run HTML Help Workshop with the" \
|
||||
".hhp project file in build/htmlhelp."
|
||||
".hhp project file in $(BUILDDIR)/htmlhelp."
|
||||
|
||||
qthelp:
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) build/qthelp
|
||||
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
|
||||
@echo
|
||||
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
|
||||
".qhcp project file in build/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator build/qthelp/OpenLP.qhcp"
|
||||
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
|
||||
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLP.qhcp"
|
||||
@echo "To view the help file:"
|
||||
@echo "# assistant -collectionFile build/qthelp/OpenLP.qhc"
|
||||
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLP.qhc"
|
||||
|
||||
devhelp:
|
||||
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
|
||||
@echo
|
||||
@echo "Build finished."
|
||||
@echo "To view the help file:"
|
||||
@echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLP"
|
||||
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLP"
|
||||
@echo "# devhelp"
|
||||
|
||||
epub:
|
||||
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
|
||||
@echo
|
||||
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
|
||||
|
||||
latex:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) build/latex
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo
|
||||
@echo "Build finished; the LaTeX files are in build/latex."
|
||||
@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
|
||||
"run these through (pdf)latex."
|
||||
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
|
||||
@echo "Run \`make' in that directory to run these through (pdf)latex" \
|
||||
"(use \`make latexpdf' here to do that automatically)."
|
||||
|
||||
latexpdf:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through pdflatex..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
latexpdfja:
|
||||
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
|
||||
@echo "Running LaTeX files through platex and dvipdfmx..."
|
||||
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
|
||||
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
|
||||
|
||||
text:
|
||||
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
|
||||
@echo
|
||||
@echo "Build finished. The text files are in $(BUILDDIR)/text."
|
||||
|
||||
man:
|
||||
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
|
||||
@echo
|
||||
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
|
||||
|
||||
texinfo:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo
|
||||
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
|
||||
@echo "Run \`make' in that directory to run these through makeinfo" \
|
||||
"(use \`make info' here to do that automatically)."
|
||||
|
||||
info:
|
||||
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
|
||||
@echo "Running Texinfo files through makeinfo..."
|
||||
make -C $(BUILDDIR)/texinfo info
|
||||
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
|
||||
|
||||
gettext:
|
||||
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
|
||||
@echo
|
||||
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
|
||||
|
||||
changes:
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) build/changes
|
||||
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
|
||||
@echo
|
||||
@echo "The overview file is in build/changes."
|
||||
@echo "The overview file is in $(BUILDDIR)/changes."
|
||||
|
||||
linkcheck:
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) build/linkcheck
|
||||
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
|
||||
@echo
|
||||
@echo "Link check complete; look for any errors in the above output " \
|
||||
"or in build/linkcheck/output.txt."
|
||||
"or in $(BUILDDIR)/linkcheck/output.txt."
|
||||
|
||||
doctest:
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) build/doctest
|
||||
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
|
||||
@echo "Testing of doctests in the sources finished, look at the " \
|
||||
"results in build/doctest/output.txt."
|
||||
"results in $(BUILDDIR)/doctest/output.txt."
|
||||
|
||||
xml:
|
||||
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
|
||||
@echo
|
||||
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
|
||||
|
||||
pseudoxml:
|
||||
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
|
||||
@echo
|
||||
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
|
||||
|
||||
scan:
|
||||
./source/scan.py
|
||||
|
|
|
|||
|
|
@ -1,9 +1,11 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# OpenLP documentation build configuration file, created by
|
||||
# sphinx-quickstart on Fri Jul 10 17:20:40 2009.
|
||||
# sphinx-quickstart on Mon Jun 16 15:48:38 2014.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its containing dir.
|
||||
# This file is execfile()d with the current directory set to its
|
||||
# containing dir.
|
||||
#
|
||||
# Note that not all possible configuration values are present in this
|
||||
# autogenerated file.
|
||||
|
|
@ -11,25 +13,36 @@
|
|||
# All configuration values have a default; values that are commented out
|
||||
# serve to show the default.
|
||||
|
||||
import os
|
||||
import sys
|
||||
import os
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
path_to_code = os.path.abspath(os.path.join(os.path.split(__file__)[0],
|
||||
'..', '..', '..', '..', 'OpenLP', 'trunk'))
|
||||
'..', '..', '..', '..', 'openlp', 'trunk'))
|
||||
if not os.path.exists(path_to_code):
|
||||
print 'Incorrect path to code, expecting "%s"' % path_to_code
|
||||
print('Incorrect path to code, expecting "%s"' % path_to_code)
|
||||
sys.exit(1)
|
||||
|
||||
sys.path.insert(0, path_to_code)
|
||||
|
||||
# -- General configuration -----------------------------------------------------
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ['sphinx.ext.autodoc']
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.autosummary',
|
||||
'sphinx.ext.intersphinx',
|
||||
'sphinx.ext.todo',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.viewcode'
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
|
@ -38,23 +51,23 @@ templates_path = ['_templates']
|
|||
source_suffix = '.rst'
|
||||
|
||||
# The encoding of source files.
|
||||
source_encoding = 'utf-8'
|
||||
#source_encoding = 'utf-8-sig'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'OpenLP'
|
||||
copyright = u'2004-2012, Raoul Snyman'
|
||||
project = 'OpenLP'
|
||||
copyright = '2004-2015, Raoul Snyman'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '2.0'
|
||||
version = '2.2'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '1.9.8'
|
||||
release = '2.2'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
|
@ -66,14 +79,12 @@ release = '1.9.8'
|
|||
# Else, today_fmt is used as the format for a strftime call.
|
||||
#today_fmt = '%B %d, %Y'
|
||||
|
||||
# List of documents that shouldn't be included in the build.
|
||||
#unused_docs = []
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
|
||||
# List of directories, relative to source directory, that shouldn't be searched
|
||||
# for source files.
|
||||
exclude_trees = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
#default_role = None
|
||||
|
||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||
|
|
@ -81,7 +92,7 @@ exclude_trees = []
|
|||
|
||||
# If true, the current module name will be prepended to all description
|
||||
# unit titles (such as .. function::).
|
||||
add_module_names = False
|
||||
#add_module_names = True
|
||||
|
||||
# If true, sectionauthor and moduleauthor directives will be shown in the
|
||||
# output. They are ignored by default.
|
||||
|
|
@ -93,31 +104,27 @@ pygments_style = 'sphinx'
|
|||
# A list of ignored prefixes for module index sorting.
|
||||
#modindex_common_prefix = []
|
||||
|
||||
# If true, keep warnings as "system message" paragraphs in the built documents.
|
||||
# keep_warnings = True
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||
# Sphinx are currently 'default' and 'sphinxdoc'.
|
||||
html_theme = 'default'
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
html_theme_options = {
|
||||
'sidebarbgcolor': '#3a60a9',
|
||||
'relbarbgcolor': '#203b6f',
|
||||
'footerbgcolor': '#26437c',
|
||||
'headtextcolor': '#203b6f',
|
||||
'linkcolor': '#26437c',
|
||||
'sidebarlinkcolor': '#ceceff'
|
||||
}
|
||||
#html_theme_options = {}
|
||||
|
||||
# Add any paths that contain custom themes here, relative to this directory.
|
||||
#html_theme_path = []
|
||||
|
||||
# The name for this set of Sphinx documents. If None, it defaults to
|
||||
# "<project> v<release> documentation".
|
||||
html_title = 'OpenLP 2.0 Developer API'
|
||||
#html_title = None
|
||||
|
||||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||||
#html_short_title = None
|
||||
|
|
@ -136,6 +143,11 @@ html_title = 'OpenLP 2.0 Developer API'
|
|||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Add any extra paths that contain custom files (such as robots.txt or
|
||||
# .htaccess) here, relative to this directory. These files are copied
|
||||
# directly to the root of the documentation.
|
||||
#html_extra_path = []
|
||||
|
||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||||
# using the given strftime format.
|
||||
#html_last_updated_fmt = '%b %d, %Y'
|
||||
|
|
@ -152,7 +164,7 @@ html_static_path = ['_static']
|
|||
#html_additional_pages = {}
|
||||
|
||||
# If false, no module index is generated.
|
||||
#html_use_modindex = True
|
||||
#html_domain_indices = True
|
||||
|
||||
# If false, no index is generated.
|
||||
#html_use_index = True
|
||||
|
|
@ -163,31 +175,43 @@ html_static_path = ['_static']
|
|||
# If true, links to the reST sources are added to the pages.
|
||||
#html_show_sourcelink = True
|
||||
|
||||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||||
#html_show_sphinx = True
|
||||
|
||||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||||
#html_show_copyright = True
|
||||
|
||||
# If true, an OpenSearch description file will be output, and all pages will
|
||||
# contain a <link> tag referring to it. The value of this option must be the
|
||||
# base URL from which the finished HTML is served.
|
||||
#html_use_opensearch = ''
|
||||
|
||||
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = ''
|
||||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'OpenLP-2.0-api'
|
||||
htmlhelp_basename = 'OpenLP-api'
|
||||
|
||||
|
||||
# -- Options for LaTeX output --------------------------------------------------
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
||||
# The paper size ('letter' or 'a4').
|
||||
#latex_paper_size = 'letter'
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#latex_font_size = '10pt'
|
||||
#'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#'preamble': '',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', 'OpenLP.tex', u'OpenLP 2.0 Developer API',
|
||||
u'Raoul Snyman', 'manual'),
|
||||
('index', 'OpenLP.tex', 'OpenLP Developer API',
|
||||
'Raoul Snyman', 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
|
|
@ -198,11 +222,131 @@ latex_documents = [
|
|||
# not chapters.
|
||||
#latex_use_parts = False
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#latex_preamble = ''
|
||||
# If true, show page references after internal links.
|
||||
#latex_show_pagerefs = False
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#latex_show_urls = False
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#latex_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#latex_use_modindex = True
|
||||
#latex_domain_indices = True
|
||||
|
||||
|
||||
# -- Options for manual page output ---------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', 'openlp', 'OpenLP Developer API',
|
||||
['Raoul Snyman'], 1)
|
||||
]
|
||||
|
||||
# If true, show URL addresses after external links.
|
||||
#man_show_urls = False
|
||||
|
||||
|
||||
# -- Options for Texinfo output -------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', 'OpenLP', 'OpenLP Developer API',
|
||||
'Raoul Snyman', 'OpenLP', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
#texinfo_appendices = []
|
||||
|
||||
# If false, no module index is generated.
|
||||
#texinfo_domain_indices = True
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#texinfo_show_urls = 'footnote'
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
|
||||
# -- Options for Epub output ----------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = 'OpenLP'
|
||||
epub_author = 'Raoul Snyman'
|
||||
epub_publisher = 'Raoul Snyman'
|
||||
epub_copyright = '2004-2015, Raoul Snyman'
|
||||
|
||||
# The basename for the epub file. It defaults to the project name.
|
||||
#epub_basename = 'OpenLP'
|
||||
|
||||
# The HTML theme for the epub output. Since the default themes are not optimized
|
||||
# for small screen space, using the same theme for HTML and epub output is
|
||||
# usually not wise. This defaults to 'epub', a theme designed to save visual
|
||||
# space.
|
||||
#epub_theme = 'epub'
|
||||
|
||||
# The language of the text. It defaults to the language option
|
||||
# or en if the language is not set.
|
||||
#epub_language = ''
|
||||
|
||||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||||
#epub_scheme = ''
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#epub_uid = ''
|
||||
|
||||
# A tuple containing the cover image and cover page html template filenames.
|
||||
#epub_cover = ()
|
||||
|
||||
# A sequence of (type, uri, title) tuples for the guide element of content.opf.
|
||||
#epub_guide = ()
|
||||
|
||||
# HTML files that should be inserted before the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_pre_files = []
|
||||
|
||||
# HTML files shat should be inserted after the pages created by sphinx.
|
||||
# The format is a list of tuples containing the path and title.
|
||||
#epub_post_files = []
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
|
||||
# The depth of the table of contents in toc.ncx.
|
||||
#epub_tocdepth = 3
|
||||
|
||||
# Allow duplicate toc entries.
|
||||
#epub_tocdup = True
|
||||
|
||||
# Choose between 'default' and 'includehidden'.
|
||||
#epub_tocscope = 'default'
|
||||
|
||||
# Fix unsupported image types using the PIL.
|
||||
#epub_fix_images = False
|
||||
|
||||
# Scale large images.
|
||||
#epub_max_image_width = 0
|
||||
|
||||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||||
#epub_show_urls = 'inline'
|
||||
|
||||
# If false, no index is generated.
|
||||
#epub_use_index = True
|
||||
|
||||
|
||||
# Example configuration for intersphinx: refer to the Python standard library.
|
||||
intersphinx_mapping = {'python': ('http://docs.python.org/3.4', None)}
|
||||
|
||||
autosummary_generate = True
|
||||
|
||||
autodoc_default_flags = ['members', 'undoc-members', 'show-inheritance']
|
||||
|
||||
autodoc_mock_imports = ['pyodbc', 'uno', 'PyQt4.phonon', 'com.sun.star.connection', 'com.sun.star.beans']
|
||||
|
|
|
|||
|
|
@ -1,18 +0,0 @@
|
|||
.. _core-index:
|
||||
|
||||
Core Application
|
||||
================
|
||||
|
||||
This is the core of the OpenLP application. Anything that is not a plugin is
|
||||
stored in the :mod:`~openlp.core` module.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
lib
|
||||
theme
|
||||
ui
|
||||
utils
|
||||
|
||||
.. automodule:: openlp.core
|
||||
:members:
|
||||
|
|
@ -1,79 +0,0 @@
|
|||
.. _core-lib:
|
||||
|
||||
Object Library
|
||||
==============
|
||||
|
||||
.. automodule:: openlp.core.lib
|
||||
:members:
|
||||
|
||||
:mod:`Manager`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.db.Manager
|
||||
:members:
|
||||
|
||||
:mod:`EventReceiver`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.eventreceiver.EventReceiver
|
||||
:members:
|
||||
|
||||
:mod:`ListWidgetWithDnD`
|
||||
------------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.listwidgetwithdnd.ListWidgetWithDnD
|
||||
:members:
|
||||
|
||||
:mod:`MediaManagerItem`
|
||||
-----------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.mediamanageritem.MediaManagerItem
|
||||
:members:
|
||||
|
||||
:mod:`Plugin`
|
||||
-------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.plugin.Plugin
|
||||
:members:
|
||||
|
||||
:mod:`PluginManager`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.pluginmanager.PluginManager
|
||||
:members:
|
||||
|
||||
:mod:`Renderer`
|
||||
---------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.renderer.Renderer
|
||||
:members:
|
||||
|
||||
:mod:`SearchEdit`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.searchedit.SearchEdit
|
||||
:members:
|
||||
|
||||
:mod:`ServiceItem`
|
||||
------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.serviceitem.ServiceItem
|
||||
:members:
|
||||
|
||||
:mod:`SettingsTab`
|
||||
------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.settingstab.SettingsTab
|
||||
:members:
|
||||
|
||||
:mod:`OpenLPToolbar`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.toolbar.OpenLPToolbar
|
||||
:members:
|
||||
|
||||
:mod:`UiStrings`
|
||||
--------------------
|
||||
|
||||
.. autoclass:: openlp.core.lib.ui.UiStrings
|
||||
:members:
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
.. _core-theme:
|
||||
|
||||
Theme Function Library
|
||||
======================
|
||||
|
||||
.. automodule:: openlp.core.theme
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.core.theme.theme.Theme
|
||||
:members:
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
.. _core-ui:
|
||||
|
||||
User Interface
|
||||
==============
|
||||
|
||||
.. automodule:: openlp.core.ui
|
||||
|
||||
Main Windows
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.core.ui.mainwindow.MainWindow
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.core.ui.maindisplay.MainDisplay
|
||||
:members:
|
||||
|
||||
Managers
|
||||
--------
|
||||
|
||||
.. autoclass:: openlp.core.ui.slidecontroller.SlideController
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.core.ui.servicemanager.ServiceManager
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.core.ui.thememanager.ThemeManager
|
||||
:members:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
.. _core-utils:
|
||||
|
||||
Utilities
|
||||
=========
|
||||
|
||||
.. automodule:: openlp.core.utils
|
||||
:members:
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Main Display
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.core.ui.maindisplay.MainDisplay
|
||||
:members:
|
||||
:noindex:
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Main Window
|
||||
-----------
|
||||
|
||||
.. autoclass:: openlp.core.ui.mainwindow.MainWindow
|
||||
:members:
|
||||
:noindex:
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Media Dock Manager
|
||||
------------------
|
||||
|
||||
.. autoclass:: openlp.core.ui.mediadockmanager.MediaDockManager
|
||||
:members:
|
||||
:noindex:
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Service Manager
|
||||
---------------
|
||||
|
||||
.. autoclass:: openlp.core.ui.servicemanager.ServiceManager
|
||||
:members:
|
||||
:noindex:
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Slide Controller
|
||||
----------------
|
||||
|
||||
.. autoclass:: openlp.core.ui.slidecontroller.SlideController
|
||||
:members:
|
||||
:noindex:
|
||||
|
|
@ -0,0 +1,6 @@
|
|||
Theme Manager
|
||||
-------------
|
||||
|
||||
.. autoclass:: openlp.core.ui.thememanager.ThemeManager
|
||||
:members:
|
||||
:noindex:
|
||||
|
|
@ -0,0 +1,20 @@
|
|||
UI Documentation
|
||||
================
|
||||
|
||||
Main Windows
|
||||
------------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
mainwindows/*
|
||||
|
||||
Managers
|
||||
--------
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
managers/*
|
||||
|
|
@ -1,22 +1,30 @@
|
|||
.. OpenLP documentation master file, created by
|
||||
sphinx-quickstart on Fri Jul 10 17:20:40 2009.
|
||||
sphinx-quickstart on Mon Jun 16 15:48:38 2014.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome
|
||||
=======
|
||||
|
||||
Welcome to the OpenLP 2.0 API Documentation! In here you will find all
|
||||
Welcome to the OpenLP 2.2 API Documentation! In here you will find all
|
||||
information relating to OpenLP's core classes, core plugins, and anything else
|
||||
deemed necessary or interesting by the developers.
|
||||
|
||||
Contents:
|
||||
API Documentation:
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
core/index
|
||||
plugins/index
|
||||
api/*
|
||||
|
||||
Documentation:
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
doc/*
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -1,31 +0,0 @@
|
|||
.. _plugins-alerts:
|
||||
|
||||
Alerts Plugin
|
||||
=============
|
||||
|
||||
.. automodule:: openlp.plugins.alerts
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.alerts.alertsplugin.AlertsPlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.alerts.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.alerts.forms.alertform.AlertForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.alerts.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.alerts.lib.db
|
||||
:members:
|
||||
|
|
@ -1,55 +0,0 @@
|
|||
.. _plugins-bibles:
|
||||
|
||||
Bibles Plugin
|
||||
=============
|
||||
|
||||
.. automodule:: openlp.plugins.bibles
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.bibles.bibleplugin.BiblePlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.bibles.forms.bibleimportform.BibleImportForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.db
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.biblestab
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.manager
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.mediaitem
|
||||
:members:
|
||||
|
||||
Bible Importers
|
||||
---------------
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.csvbible
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.http
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.osis
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.bibles.lib.opensong
|
||||
:members:
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
.. _plugins-custom:
|
||||
|
||||
Custom Slides Plugin
|
||||
====================
|
||||
|
||||
.. automodule:: openlp.plugins.custom
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.custom.customplugin.CustomPlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.custom.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.custom.forms.editcustomform.EditCustomForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.custom.forms.editcustomslideform.EditCustomSlideForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.custom.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.custom.lib.mediaitem
|
||||
:members:
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
.. _plugins-images:
|
||||
|
||||
Images Plugin
|
||||
=============
|
||||
|
||||
.. automodule:: openlp.plugins.images
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.images.imageplugin.ImagePlugin
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.images.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.images.lib.mediaitem
|
||||
:members:
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
.. _plugins-index:
|
||||
|
||||
Plugins
|
||||
=======
|
||||
|
||||
.. automodule:: openlp.plugins
|
||||
:members:
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
songs
|
||||
bibles
|
||||
presentations
|
||||
media
|
||||
images
|
||||
custom
|
||||
remotes
|
||||
songusage
|
||||
alerts
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
.. _plugins-media:
|
||||
|
||||
Media Plugin
|
||||
============
|
||||
|
||||
.. automodule:: openlp.plugins.media
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.media.mediaplugin.MediaPlugin
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.media.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.media.lib.mediaitem
|
||||
:members:
|
||||
|
|
@ -1,40 +0,0 @@
|
|||
.. _plugins-presentations:
|
||||
|
||||
Presentations Plugin
|
||||
====================
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.presentations.presentationplugin.PresentationPlugin
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.mediaitem
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.presentationtab
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.messagelistener
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.presentationcontroller
|
||||
:members:
|
||||
|
||||
Presentation Application Controllers
|
||||
------------------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.impresscontroller
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.pptviewcontroller
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.presentations.lib.powerpointcontroller
|
||||
:members:
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
.. _plugins-remotes:
|
||||
|
||||
Remotes Plugin
|
||||
==============
|
||||
|
||||
.. automodule:: openlp.plugins.remotes
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.remotes.remoteplugin.RemotesPlugin
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.remotes.lib
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.remotes.lib.httpserver.HttpConnection
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.remotes.lib.httpserver.HttpResponse
|
||||
:members:
|
||||
|
|
@ -1,97 +0,0 @@
|
|||
.. _plugins-songs:
|
||||
|
||||
Songs Plugin
|
||||
============
|
||||
|
||||
.. automodule:: openlp.plugins.songs
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.songsplugin.SongsPlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.songs.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.authorsform.AuthorsForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.editsongform.EditSongForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.editverseform.EditVerseForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.songbookform.SongBookForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.songimportform.SongImportForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.songmaintenanceform.SongMaintenanceForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.forms.topicsform.TopicsForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.db
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.mediaitem
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.songimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.songstab
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.xml
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.upgrade
|
||||
:members:
|
||||
|
||||
Song Importers
|
||||
--------------
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.cclifileimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.ewimport
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songs.lib.ewimport.FieldDescEntry
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.olp1import
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.olpimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.oooimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.opensongimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.sofimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.songbeamerimport
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songs.lib.wowimport
|
||||
:members:
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
.. _plugins-songusage:
|
||||
|
||||
Song Usage Plugin
|
||||
=================
|
||||
|
||||
.. automodule:: openlp.plugins.songusage
|
||||
:members:
|
||||
|
||||
Plugin Class
|
||||
------------
|
||||
|
||||
.. autoclass:: openlp.plugins.songusage.songusageplugin.SongUsagePlugin
|
||||
:members:
|
||||
|
||||
Forms
|
||||
-----
|
||||
|
||||
.. automodule:: openlp.plugins.songusage.forms
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songusage.forms.songusagedeleteform.SongUsageDeleteForm
|
||||
:members:
|
||||
|
||||
.. autoclass:: openlp.plugins.songusage.forms.songusagedetailform.SongUsageDetailForm
|
||||
:members:
|
||||
|
||||
Helper Classes & Functions
|
||||
--------------------------
|
||||
|
||||
.. automodule:: openlp.plugins.songusage.lib
|
||||
:members:
|
||||
|
||||
.. automodule:: openlp.plugins.songusage.lib.db
|
||||
:members:
|
||||
|
|
@ -0,0 +1,120 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
import os
|
||||
import sys
|
||||
import shutil
|
||||
from modulefinder import ModuleFinder
|
||||
import pkgutil
|
||||
import string
|
||||
import multiprocessing
|
||||
|
||||
PACKAGE_RST = string.Template("""$underline
|
||||
$title
|
||||
$underline
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 2
|
||||
|
||||
$title/*
|
||||
|
||||
.. automodule:: $module
|
||||
""")
|
||||
|
||||
MODULE_RST = string.Template("""$underline
|
||||
$title
|
||||
$underline
|
||||
|
||||
.. automodule:: $module
|
||||
$exclude""")
|
||||
|
||||
|
||||
def find_modules(importer, module, package):
|
||||
if module.startswith('openlp'):
|
||||
title = str(module.split('.')[-1])
|
||||
underline = str(len(title) * '=')
|
||||
values = {'underline': underline, 'title': title, 'module': module}
|
||||
path = os.path.join(find_modules.root_path, module.replace('.', os.path.sep) + '.rst')
|
||||
if package:
|
||||
with open(os.path.join(path), 'w+') as file:
|
||||
file.write(PACKAGE_RST.substitute(values))
|
||||
else:
|
||||
finder = ModuleFinder()
|
||||
exclude = ''
|
||||
try:
|
||||
finder.run_script(os.path.join(importer.path, title + '.py'))
|
||||
except ImportError:
|
||||
print('Failed to import {0}{1}'.format(module, ' '*25))
|
||||
raise
|
||||
except:
|
||||
print('Failed in module {0}'.format(module))
|
||||
raise
|
||||
for name in finder.modules.keys():
|
||||
if name.startswith('sqlalchemy'):
|
||||
exclude = " :exclude-members: mapper, or_, and_\n"
|
||||
values['exclude'] = exclude
|
||||
with open(os.path.join(path), 'w+') as file:
|
||||
file.write(MODULE_RST.substitute(values))
|
||||
find_modules.queue.put(module)
|
||||
|
||||
|
||||
def find_modules_init(queue, root_path):
|
||||
find_modules.queue = queue
|
||||
find_modules.root_path = root_path
|
||||
|
||||
|
||||
def progress(queue, number):
|
||||
progress_percentage = 0
|
||||
while number > progress_percentage:
|
||||
try:
|
||||
module = queue.get(True, 5)
|
||||
except queue.Empty:
|
||||
break
|
||||
percent = round((progress_percentage/number)*100)
|
||||
sys.stdout.write('{0}% File: {1}{2}\r'.format(percent, module, ' '*25))
|
||||
sys.stdout.flush()
|
||||
progress_percentage += 1
|
||||
sys.stdout.write('100%{0}\n'.format(' '*50))
|
||||
sys.stdout.flush()
|
||||
|
||||
|
||||
def main():
|
||||
modules = []
|
||||
|
||||
path_to_code = os.path.abspath(os.path.join(os.path.split(__file__)[0],
|
||||
'..', '..', '..', '..', 'openlp', 'trunk'))
|
||||
if not os.path.exists(path_to_code):
|
||||
print('Incorrect path to code, expecting "%s"' % path_to_code)
|
||||
sys.exit(1)
|
||||
|
||||
root_path = os.path.abspath(os.path.join(os.path.split(__file__)[0], 'api'))
|
||||
|
||||
sys.path.insert(0, path_to_code)
|
||||
|
||||
if os.path.isdir(root_path):
|
||||
shutil.rmtree(root_path)
|
||||
os.makedirs(root_path)
|
||||
|
||||
pkg = pkgutil.walk_packages([path_to_code], onerror=print)
|
||||
|
||||
for importer, module, package in pkg:
|
||||
if module.startswith('openlp'):
|
||||
path = os.path.join(root_path, module.replace('.', os.path.sep))
|
||||
if package:
|
||||
if not os.path.exists(path):
|
||||
os.makedirs(path)
|
||||
modules.append([importer, module, package])
|
||||
|
||||
del sys.path[0]
|
||||
|
||||
queue = multiprocessing.Queue()
|
||||
thread = multiprocessing.Process(target=progress, args=(queue, len(modules)))
|
||||
thread.start()
|
||||
pool = multiprocessing.Pool(None, find_modules_init, [queue, root_path])
|
||||
pool.starmap(find_modules, modules)
|
||||
pool.close()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in New Issue