Merge pull request #6 from linz/docs

Add documentation in prep to build on readthedocs

CHANGELOG.rst

@@ -4,6 +4,22 @@ Change Log
 
 All notable changes to this project will be documented in this file.
 
+0.4.0 - 2017-07-24
+==================
+
+Added
+-----
+
+ * Save confirmation if settings dialog closed with unsaved settings
+ * Directory validation and handling for missing dirs
+ * Documentation via readthedocs
+
+Changed
+-------
+
+ * Using plugin specific Settings instead of using QGIS Settings
+ * Improved self testing
+
 0.3.0 - 2017-05-19
 ==================
 

README.rst

@@ -10,18 +10,35 @@ QGIS Script Assistant Plugin
 
 This is a QGIS plugin with three helper tools for QGIS development purposes:
 
-* Reload scripts into QGIS from any existing directory
+* Reload processing user scripts into QGIS from any existing directory
 * Run tests within QGIS in a way that makes them configurable for local and travis-ci testing without any manual amendments
 * Add all of the test data referred to in those tests with a click
 
 These tools make life easier if you:
 
-* store user scripts in a .git repository and need to load development versions into QGIS Processing (different use case to the QGIS Resource Sharing plugin which allows sharing of finished scripts)
+* store user scripts in a .git repository and need to load development versions into QGIS processing (different use case to the QGIS Resource Sharing plugin which allows sharing of finished scripts)
 * want to edit scripts and tests in your text editor of choice, and easily reload / run in QGIS
 * want to use ``__file__`` - this doesn't work in the QGIS Python Console but does work with the provided test runner
 
-Notes:
-======
+Installation
+============
+
+This plugin will soon be available through the official QGIS plugin repository.
+
+To install it for development purposes, clone this repository and then symlink the scriptassistant/ dir to ``/$user/.qgis2/python/plugins/scriptassistant``.
+
+Documentation
+=============
+
+See the full docs on readthedocs.
+
+Tests
+=====
+
+On installation, the plugin is configured to test itself. Click the Run Tests button to test.
+
+Limitations
+===========
 
 * Scripts named in the format ``test_x.py`` must be within the test directory - subdirectories are ignored.
 * The ``tests_x.py`` script must have a ``run_tests`` function in order for tests to be called.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = QGISScriptAssistantPlugin
+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)

docs/conf.py

@@ -0,0 +1,171 @@
+# -*- coding: utf-8 -*-
+#
+# QGIS Script Assistant Plugin documentation build configuration file, created by
+# sphinx-quickstart on Thu Jul 20 14:30:06 2017.
+#
+# 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.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# 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
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- 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 = []
+
+# 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'
+
+# General information about the project.
+project = u'QGIS Script Assistant Plugin'
+copyright = u'2017, LINZ'
+author = u'Daniel Silk'
+
+# 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 = u'0.4'
+# The full version, including alpha/beta/rc tags.
+release = u'0.4.0'
+
+# 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 patterns also effect to 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 = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = 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 = 'alabaster'
+
+# 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.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+html_sidebars = {
+    '**': [
+        'about.html',
+        'navigation.html',
+        'relations.html',  # needs 'show_related': True theme option to display
+        'searchbox.html',
+        'donate.html',
+    ]
+}
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'QGISScriptAssistantPlugindoc'
+
+
+# -- 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, 'QGISScriptAssistantPlugin.tex', u'QGIS Script Assistant Plugin Documentation',
+     u'Daniel Silk', '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, 'QGISScriptAssistantPlugin', u'QGIS Script Assistant Plugin 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, 'QGISScriptAssistantPlugin', u'QGIS Script Assistant Plugin Documentation',
+     author, 'QGISScriptAssistantPlugin', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+

docs/configuration.rst

@@ -0,0 +1,5 @@
+=============
+Configuration
+=============
+
+The plugin is configured using the Settings Dialog.

docs/index.rst

@@ -0,0 +1,21 @@
+.. QGIS Script Assistant Plugin documentation master file, created by
+   sphinx-quickstart on Thu Jul 20 14:30:06 2017.
+
+
+Script Assistant Docs
+=====================
+
+.. toctree::
+   :maxdepth: 2
+
+   overview
+   configuration
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+set SPHINXPROJ=QGISScriptAssistantPlugin
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.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

docs/overview.rst

@@ -0,0 +1,29 @@
+========
+Overview
+========
+
+This is a QGIS plugin with three helper tools for QGIS development purposes.
+
+Reload Scripts
+==============
+
+Load / reload processing user scripts into QGIS from any existing directory.
+
+.. image:: images/reload_scripts.gif
+    :align: center
+
+Run Tests
+=========
+
+Run tests within QGIS in a way that makes them configurable for local and Travis-CI testing without any manual amendments.
+
+.. image:: images/run_tests.gif
+    :align: center
+
+Add Test Data
+=============
+
+Add all of the test data referred to in those tests with a click.
+
+.. image:: images/add_test_data.gif
+    :align: center

scriptassistant/plugin.py

@@ -200,16 +200,14 @@ def reload_scripts(self):
         QGIS scripts folder.
         """
         folder_dir = gui.settings_manager.load_setting("script_folder")
+        user_script_dir = os.path.join(
+            QgsApplication.qgisSettingsDirPath(), "processing", "scripts"
+        )
         if folder_dir:
             for filename in os.listdir(folder_dir):
                 if filename.endswith(".py") and not filename.startswith("_"):
                     if self.is_processing_script(os.path.join(folder_dir, filename)):
-                        # QGIS 2.14 has ScriptUtils.scriptsFolder()
-                        if QGis.QGIS_VERSION_INT < 21800:
-                            copy(os.path.join(folder_dir, filename), ScriptUtils.scriptsFolder())
-                        # QGIS 2.18 has ScriptUtils.scriptsFolders()[0]
-                        elif QGis.QGIS_VERSION_INT >= 21800:
-                            copy(os.path.join(folder_dir, filename), ScriptUtils.scriptsFolders()[0])
+                        copy(os.path.join(folder_dir, filename), user_script_dir)
             plugins["processing"].toolbox.updateProvider("script")
         else:
             self.iface.messageBar().pushMessage(