Merge branch 'makeflitinstall' of https://github.com/dictation-toolbo…

…x/dtactions into makeflitinstall

.gitignore

@@ -69,12 +69,18 @@ instance/
 .scrapy
 
 # Sphinx documentation
-docs/_build/
+documentation/_build/
 
 # PyBuilder
 .pybuilder/
 target/
 
+# Backup files
+*~
+
+# Emacs
+*\#
+
 # Jupyter Notebook
 .ipynb_checkpoints
 

documentation/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

documentation/conf.py

@@ -0,0 +1,222 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# 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.
+#
+import os
+import sys
+
+src_directory = os.path.join(os.path.abspath('..'), "src")
+sys.path.insert(0, src_directory)
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'dtactions'
+copyright = '2021, Quintijn Hoogenboom'
+author = 'Quintijn Hoogenboom'
+
+# The short X.Y version
+version = '1.1'
+# The full version, including alpha/beta/rc tags
+release = '1.1.0'
+
+
+# ----------------------------------------------------------------------------
+# Mock libraries that are only available on some platforms or with optional
+# dependencies installed.
+
+from mock import MagicMock
+
+class Mock(MagicMock):
+    @classmethod
+    def __getattr__(cls, name):
+        return MagicMock()
+
+
+mock_modules = {
+    'ctypes',
+    'win32api',
+    'win32clipboard',
+    'win32con',
+    'win32gui',
+    'win32process',
+    'winxpgui',
+}
+
+for module_name in mock_modules:
+    sys.modules[module_name] = Mock()
+
+
+# -- General configuration ---------------------------------------------------
+
+# 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.intersphinx',
+    'sphinx.ext.todo',
+    'sphinx.ext.viewcode',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+# templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+# Whether module names should be prepended to all object names.
+add_module_names = False
+
+
+# -- 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 = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+# html_static_path = ['_static']
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'dtactionsdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'dtactions.tex', 'dtactions Documentation',
+     'Quintijn Hoogenboom', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'dtactions', 'dtactions Documentation',
+     [author], 1)
+]
+
+
+# -- 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 = [
+    (master_doc, 'dtactions', 'dtactions Documentation',
+     author, 'dtactions',
+     'Common OS action and related code from dictation-toolbox projects.',
+     'Miscellaneous'),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# 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 list of files that should not be packed into the epub file.
+epub_exclude_files = ['search.html']
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+# intersphinx_mapping = {'https://docs.python.org/': None}
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

documentation/documentation.rst

@@ -0,0 +1,45 @@
+
+Documentation
+==============================================================================
+
+The documentation for DT Actions is written in `reStructuredText format`_.
+ReStructuredText is similar to the Markdown format. If you are unfamiliar
+with the format, the `reStructuredText primer`_ might be a good starting
+point.
+
+The `Sphinx documentation engine`_ and `Read the Docs`_ are used to
+generate documentation from the *.rst* files in the *documentation/* folder.
+Docstrings in the source code are included in a semi-automatic way through use
+of the `sphinx.ext.autodoc`_ extension.
+
+To build the documentation locally, install Sphinx and any other documentation
+requirements:
+
+.. code:: shell
+
+   $ cd documentation
+   $ pip install -r requirements.txt
+
+Then run the following command on Windows to build the documentation:
+
+.. code:: shell
+
+   $ make.bat html
+
+Or use the Makefile on other systems:
+
+.. code:: shell
+
+   $ make html
+
+If there were no errors during the build process, open the
+*_build/html/index.html* file in a web browser. Make changes, rebuild the
+documentation and reload the doc page(s) in your browser as you go.
+
+
+.. Links.
+.. _Read the docs: https://readthedocs.org/
+.. _Sphinx documentation engine: https://www.sphinx-doc.org/en/master/
+.. _reStructuredText format: http://docutils.sourceforge.net/rst.html
+.. _restructuredText primer: http://docutils.sourceforge.net/docs/user/rst/quickstart.html
+.. _sphinx.ext.autodoc: https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html

documentation/index.rst

@@ -0,0 +1,17 @@
+Welcome to dtactions's documentation!
+==============================================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   modules
+   project
+
+
+Indices and tables
+==============================================================================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

documentation/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

documentation/modules.rst

@@ -0,0 +1,10 @@
+Modules
+==============================================================================
+
+This section includes the available modules in DT actions.
+
+.. toctree::
+   :maxdepth: 2
+
+   natlinkclipboard
+   monitorfunctions

documentation/monitorfunctions.rst

@@ -0,0 +1,13 @@
+
+.. _RefMonitorFunctions:
+
+monitorfunctions
+============================================================================
+The :code:`monitorfunctions` module provides various functions related to
+monitors and windows.
+
+monitorfunctions reference
+----------------------------------------------------------------------------
+
+.. automodule:: dtactions.monitorfunctions
+   :members: