Ci docs

.gitignore

@@ -67,6 +67,7 @@ instance/
 
 # Sphinx documentation
 docs/_build/
+docs/api/
 
 # PyBuilder
 target/

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "docs"]
-	path = docs
-	url = git@github.com:wwfxuk/tk-katana.wiki.git

.travis.yml

@@ -0,0 +1,37 @@
+language: python
+
+python:
+    - "2.7"
+
+before_install:
+  # required dependency for sphinx
+  - sudo apt-get install -y pandoc
+
+install:
+  #
+  # install pyside for Qt.py - from https://stackoverflow.com/questions/24489588
+  - sudo apt-get install -y libqt4-dev
+  - pip install PySide --no-index --find-links https://parkin.github.io/python-wheelhouse/;
+  - python ~/virtualenv/python${TRAVIS_PYTHON_VERSION}/bin/pyside_postinstall.py -install
+  #
+  # Documentation dependencies
+  - pip install -r ./docs/requirements.txt
+
+script:
+  # Generate docs
+  - sphinx-apidoc -o ./docs/api --separate --no-toc ./
+  - sphinx-apidoc -o ./docs/api/hooks --separate --tocfile index ./hooks
+  - sphinx-build ./docs ./docs/_build
+
+deploy:
+  # When committing to master, auto-deploy to github-pages
+  # This will copy the contents of the _build folder to gh-pages branch and push
+- provider: pages
+  local-dir: ./docs/_build
+  target-branch: gh-pages
+  skip-cleanup: true
+  github-token: $GITHUB_TOKEN
+  on:
+    # only do this when on the master branch
+    # Make sure this matches conf.py html_context["github_version"]
+    branch: master

README.md

@@ -1,19 +1,28 @@
 # tk-katana
 
-This engine provides Shotgun Toolkit integration for The Foundry's Katana.
+[![Build Status][]](https://travis-ci.com/wwfxuk/tk-katana)
+[![Docs GitHub Pages][]](https://wwfxuk.github.io/tk-katana)
+[![GitHub release][]](https://github.com/wwfxuk/tk-katana/releases)
+[![Linting][]](https://houndci.com)
+[![Katana Minimum 3.1v1][]](https://learn.foundry.com/katana/3.1/Content/release_notes/Katana%203.1v1%20Release%20Notes.html)
 
--------------------------------------------------------------------------------
 
-For more information and documentation, check out the
-[GitHub wiki for this project](https://github.com/wwfxuk/tk-katana/wiki):
+This engine provides Shotgun Toolkit integration for The Foundry's Katana.
 
-* [Installation](https://github.com/wwfxuk/tk-katana/wiki/Installation)
-* [Authors and credits](https://github.com/wwfxuk/tk-katana/wiki/Authors)
-* [Change Log/History](https://github.com/wwfxuk/tk-katana/wiki/Change-Log)
+For more information and documentation, check out the
+[GitHub Pages for this project](https://wwfxuk.github.io/tk-katana/)
 
-This repository is forked from
-[robblau's v0.1.0](https://github.com/robblau/tk-katana/tree/b9cca6e4009ff84870d6e691c2b25e818dc99d1a)
+This repository is forked from [robblau's v0.1.0][]
 to hopefully make it production capable again for:
 
 * Shotgun 8 and above
-* Katana 3.1 (PyQt5) using [Qt.py 1.1.0](https://github.com/mottosso/Qt.py/tree/1.1.0)
+* Katana 3.1 (PyQt5) using [Qt.py 1.1.0][]
+
+
+[robblau's v0.1.0]: https://github.com/robblau/tk-katana/tree/b9cca6e4009ff84870d6e691c2b25e818dc99d1a
+[Qt.py 1.1.0]: https://github.com/mottosso/Qt.py/tree/1.1.0
+[Build Status]: https://travis-ci.com/wwfxuk/tk-katana.svg?branch=master
+[Docs GitHub Pages]: https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg
+[GitHub release]: https://img.shields.io/github/release/wwfxuk/tk-katana.svg
+[Linting]: https://img.shields.io/badge/PEP8%20by-Hound%20CI-a873d1.svg
+[Katana Minimum 3.1v1]: https://img.shields.io/badge/minimum-3.1v1-yellow.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAAsSAAALEgHS3X78AAAAB3RJTUUH3AEbCjozhL61YwAAB7FJREFUeNrNW8tx2zoUPeF4uJUK4IyZCqxUIGbNhZkKrFRguQLTFYSuwFQFlhdcm6ogVAfUDAuQttzkLXThwFcAAYikXjCjSfQxiXtwcO4P/PLnzx+MPdoiiADMAIT0rxg3AGoAB3q/B1DRq/bjphp7bl/GAKAtghDAAkAEYN7jUjWADYASwNqPm/0/C0BbBFMy+o6t8lBjD+ANQO7HTfnPAECGLwHcA5h2/LQiI+TJl7QtQno/JfBmhmuVAJ6GAKIXAG0RLAD80kx2DyCnyW5c6UvbaA4goZcOiJ9+3NQXBaAtghkZHim+XhNN3wbUlCmAWwCpxBZ5PPlxk14EgI5Vz2kitQRSRK8ZgGv2+y2JnBC42vL+d7TlZgo2/HBlmhMAbRG8kNDxvf0g9iMBtCQX5zK2ADI/bnLLudwTI6Zs2313cZ9WABAFfymMT/24eZJ8fUqrWkuiF0qvSMEEFRBLG4Gjeb2yrbinBckHAYBu8s4otye6lbIu2CBPW2NJ7rJrWO/rtggeCXx5/LQBwQaAV6bCFdFs31PYQgAZiZtuvAFY2NxLo00//LhZnw2AYs8PYrxi4hmAieYnGz9uIgfv9C6BYNQELQAkMtmYxrOJlx0grPy4WThc6zcLp7/p5u11XCRTqOvgxgMArVAkJUV83LVFkDhc66f0UQjgRfd7T/P5K3s/mvFs4suOn+QkyDbXygE8Sx8lxGgzAKSocrT1cIm0VJr4RvP1xAAQv9aStu2Hy1YB6CmUWb5J5cdNNnKtgIe2XXt9acsC4QWk/4tYppMBj8yN/BzR8GlbBBlPdCgkXnWwIHFgQQ3gSQaXA+4pihiy8lYjGT8TlR8Nw7p8d+J4u4w8gbzISgbwyCwdyfgFualSF6lR8KLzCJGjruwZoz6xwNPsvVWfHNtg/AuAnYWg6dg3IQa5skD2Yh/R5xVN7JYpfz6AsCU4LYLOJeMiA9VL6OuJU1cWtEWwoqoVCPznDwDYvqrPKTVJpbGFRcZ3C+C2LQIQPQet8+niCAmAUCRvngKAN1fD2yIQafCjhfEnUR6A97YISgdqR67Wk6DXnI0e3XTKqOeq5o8dcbztmAP4TWCaxrls2XBv4vF9ZkofFWp+PTBVH9siWGtqf33HmrPoit1o46jmY41bw/fneqiKi/WVotJjMj7qYfxGoq/oAbh2jg7numg/bmoSXjGuOQMqC6VfW95vhdMaYKkqc1Gqu7QEo6+3qKRFjzwGgIkBuYXYbQB8pQKGbfq6pqrPdxyLoqY59BmHrmSoMlDftDcf/LiJJIpOHClaGiLEna1I2w7P4bepAdVvcmKj8ek2/jsbevWZay2dAZD6dNrARJE5qug/M9wng76hsju3/cXuG57DgMRAe9XW2WsSmaTDtd6PkIAlbDE6AYgcAXjTVYw6agnJGXHFAcD1GVmguF/ZpQGVI4U+lahcFFfE/nI+TrR/MbjTRLV6lluX1zk+eT2PUTXS+H6VmtvUDHTgZm0RRG0R1AbaP/txsyDvsIX7yZNMIXxyXFJxBoQOq7/me01RsFx3hLrvHXnEAce21tLSO+g05VZyryrPVF8xAK7bIggtVvag8McVjrX7j3rfmQnNCseuc60AM7M0Xm7srDQM3/txs/MUAmHjq0tVnO3HTUJ/v4ddB1he8ZWIIFULQLW9taXxpbRtc41tJQB4ftzsWHYVWWReVVfCQUZMKbR9tgBgoTPcJQ8glycbv2GVplMAFBf+tJf7FEf9uClpH5vS7Ne2CDJT00PXnpN6DK9MsFMGzoTrk6cQGFXzYdszH19AX+YW4x5A3RZBqugWad0cGa7yJs9s9RcsK92Jggj8uNmSSwqlH+eMLjcGb2HKw5cWdYQJldce2yLY0n15LU8cuY06wuYtW/2QJXIftl0xNyOYMG+LIJIQzPuGqX7c5DSRR8s/uYH7QSshqBHbLikL0deqUDhnQVHKwtqdbVLTAUKKz726oceWG6+IBjM/bg4nANCHshbMKZhQoRj1YEKKY9f2MLDxb5qsNGern3UlQ7yR+KHM1MfbSlldHxDWxKLVAIbvcDwRlnAvQco/163+CQD05ZKJUq5JfhY9NaGmstm3M4HYAXgAMFM1WWnh5M9rcaZRHspDUm0RvDOaP4i0l6orQsi+DtVEpQlH+Hu0dsb8tjhaW+F4tNZUwC3Z6kd+3GxsAZjQzZRn7toiyElYrI+wXXJI85Op/2BdE6StwIMhkeiAqLsioVz+Y8anzPhKZ3xnSYzosmB6UDIQHgD8OrNSM4bxGYsz9iaP5RmEasWEZIJjA3NB32ckYmkfrzAg7e+58Vz1rTRAcXHVMflnuWDBIsdLGh7SIs0VxpuaLPbPC2hOZG8BJGMcp7GcU4LTbpW18U4A0A3voG5OPJHS7v/HVRd1CiPtzwaAbn5DyUSoSEKyMYEgw1NNpSnrUvvBAJDihBTqsvgBfx+cKgcweoq/T46pepM1jk+YnPWQVt/H5m5o1aOOcLUUeb3twUvpUVsRGeqarKkqvr8YANKE5zQZG1e466gozWDuKIuMLhdVnT5j0GeHiRFLout0YAmoSPjyPis+KgAMjFuW3LiOvbR91kOs9kUB0GyTkF5TnJ5NEvpQ4ti02F5iXv8Bj+bj7jd0Z2IAAAAASUVORK5CYII=

docs/authors.rst

@@ -0,0 +1,40 @@
+Authors
+=======
+
+Maintainer
+----------
+
+This repository is actively maintained by WWFX UK.
+
+* `Joseph Yu`_
+* `Liam Hoflay`_
+
+Contributors and Credits
+------------------------
+
+* It has been generously made public by Light Chaser Animation with help from
+  The Foundry.
+
+  * Thanks to `Ying Jie Kong (Jerry)`_ at Light Chaser and `Sam Saxon`_ at
+    The Foundry for their contributions
+  * Thanks to `Rob Blau`_ for initial release `v0.1.0`_
+
+* `Jeremy Boissinot`_ and `Kevin Sallee`_ at RodeoFX for patches up to `v0.1.1_rdo3`_
+* ``AppCommand`` changes by `Gael-Honorez-sb`_
+* `Diego Garcia Huerta`_ for the inspirational and up-to-date `tk-natron`_
+* `demon7x`_ for forking and patches since ``v0.1.0+wwfx.1.0.0``
+
+
+.. _`Diego Garcia Huerta`: https://github.com/diegogarciahuerta
+.. _`Gael-Honorez-sb`: https://github.com/Gael-Honorez-sb/tk-katana/commit/e06ab6b6b38960efbbdb18dc73b139aae278b040
+.. _`Jeremy Boissinot`: http://jboissinot.com
+.. _`Kevin Sallee`: https://github.com/kevinsallee
+.. _`Rob Blau`: https://github.com/robblau
+.. _`v0.1.0`: https://github.com/robblau/tk-katana/tree/b9cca6e4009ff84870d6e691c2b25e818dc99d1a
+.. _`Sam Saxon`: https://github.com/sam-saxon
+.. _`tk-natron`: https://github.com/diegogarciahuerta/tk-natron
+.. _`v0.1.1_rdo3`: https://github.com/rodeofx/tk-katana/commit/0ddace4f285ff7f9642c165d3d225754584bbaf9
+.. _`Ying Jie Kong (Jerry)`: https://github.com/JerryKon
+.. _`demon7x`: https://github.com/demon7x
+.. _`Joseph Yu`: https://github.com/j0yu
+.. _`Liam Hoflay`: https://github.com/liametc

docs/changelog.rst

@@ -0,0 +1,83 @@
+Change Log/History
+==================
+
+See also the `GitHub Releases page`_
+
+v0.1.0+wwfx.1.5.0 (11 Jun 2019)
+-------------------------------
+- Moved documentation to GitHub Pages from GitHub Wiki
+- Added CI for making docs
+
+v0.1.0+wwfx.1.4.0 (5 Jun 2019)
+------------------------------
+- Qt patches
+- Logging updates
+- Resource loading
+- Publishing and loading updates
+
+v0.1.0+wwfx.1.3.1 (29 May 2019)
+-------------------------------
+- Wiki/Documentation updated
+- Updated ``configs`` for specific app/engine/framework requirements.
+
+v0.1.0+wwfx.1.3.0 (29 May 2019)
+-------------------------------
+Initial working GUI for Katana 3.1 (PyQt5)
+
+Still rough and switching context is not working but hey, we have GUI!
+
+- Used `Qt.py 1.1.0`_ to achieve
+  a initial working Qt binding for Katana 3.1 (PyQt5)
+- Updated ``configs`` folder for example ``tk-multi-*``
+- Removed test panels, deferred Qt imports in ``tk_katana``
+
+v0.1.0+wwfx.1.2.3 (12 Apr 2019)
+-------------------------------
+
+- Cheeky icons for "Jump to" menu actions
+- Removed ``os.system``, using unified open with ``QDesktopService.openUrl()``
+- Fixed pre-mature call to generate Shotgun menu
+
+v0.1.0+wwfx.1.2.2 (11 Apr 2019)
+-------------------------------
+
+- Logging in ``engine.py``
+- Plugin-logger in ``ShotgunAssetPlugin``
+- Remove print/refactor to python 3 print
+- Remove unused, e.g. ``_non_pane_menu_callback_wrapper``
+
+v0.1.0+wwfx.1.2.1 (10 Apr 2019)
+-------------------------------
+
+- Fixed and updated ``startup/bootstrap.py`` from ``tk-natron`` code.
+- Initial move to "SGTK_*" environment variables.
+
+v0.1.0+wwfx.1.2.0 (04 Apr 2019)
+-------------------------------
+
+- Re-created package using Cookiecutter for Python.
+
+v0.1.0+wwfx.1.1.0 (03 Apr 2019)
+-------------------------------
+
+- Merged in ``demon7x/tk-katana`` fork's, master branch's `adb98c1`_
+
+v0.1.0+wwfx.1.0.0 (22 Jan 2019)
+-------------------------------
+
+- Added patches by Rodeo FX up to `v0.1.1_rdo3`_
+- Added ``AppCommand`` changes by `Gael-Honorez-sb`_
+
+v0.1.0 (03 Mar 2016)
+--------------------
+
+- Initial tag, pre-release by `Rob Blau`_ (`b9cca6e`_).
+
+
+.. _`Rob Blau`: https://github.com/robblau
+.. _`b9cca6e`: https://github.com/robblau/tk-katana/tree/b9cca6e4009ff84870d6e691c2b25e818dc99d1a
+.. _`v0.1.1_rdo3`: https://github.com/rodeofx/tk-katana/commit/0ddace4f285ff7f9642c165d3d225754584bbaf9
+.. _`Gael-Honorez-sb`: https://github.com/Gael-Honorez-sb/tk-katana/commit/e06ab6b6b38960efbbdb18dc73b139aae278b040
+.. _`adb98c1`: https://github.com/demon7x/tk-katana/commit/adb98c1ded02fa2de2d78177396e97d4ae56c4b0
+.. _`Qt.py 1.1.0`: https://github.com/mottosso/Qt.py/tree/1.1.0
+.. _`GitHub Releases page`: https://github.com/wwfxuk/tk-katana/releases

docs/conf.py

@@ -0,0 +1,178 @@
+# -*- 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 datetime
+import pkg_resources
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))  # tk-katana repository root
+
+# -- Project information -----------------------------------------------------
+
+project = u'tk-katana'
+
+# For logos, images used
+author = u'The Foundry, Shotgunsoftware, Rob Blau, Joseph Yu, Liam Hoflay'
+copyright = u'{0.year}, {1}'.format(datetime.date.today(), author)
+
+# The short X.Y version
+version = None
+# The full version, including alpha/beta/rc tags
+release = None
+
+# Parse every word in the first 20 lines of changelog.rst for valid versions
+with open('changelog.rst', 'r') as changelog:
+    max_count = 20
+    for line_count, line in enumerate(changelog, start=1):
+        for word in line.split():
+            try:
+                pkg_resources.packaging.version.Version(word)
+                version = word
+                release = word
+                break   # Break out of: for word in line.split()
+            except pkg_resources.packaging.version.InvalidVersion:
+                pass
+
+        if (version and release) or line_count == max_count:
+            break  # Break out of: for line in changelog
+
+    if not(version and release):
+        raise ValueError(
+            'No valid version number/word found in the first {0} '
+            'lines of changelog.rst'.format(max_count)
+        )
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+needs_sphinx = '1.8'
+
+# 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.todo',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.githubpages',
+]
+
+# 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']
+
+# 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
+
+# A boolean that decides whether module names are prepended to all object names
+# (for object types where a “module” of some kind is defined),
+# e.g. for py:function directives. Default is True.
+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 = {}
+
+# A dictionary of values to pass into the template engine’s context for
+# all pages. Single values can also be put in this dictionary using the
+# -A command-line option of sphinx-build.
+html_context = {
+    # https://github.com/rtfd/sphinx_rtd_theme/blob/a3ab477aaa23f3b7ab7d62c7abc2cc74102ab2b8/sphinx_rtd_theme/breadcrumbs.html#L45
+    'display_github': True,
+    'github_user': 'wwfxuk',
+    'github_repo': 'tk-katana',
+    'github_version': 'master',  # Double check .travis.yml pages deploy branch
+    'conf_py_path': '/docs/',
+}
+
+# The URL which points to the root of the HTML documentation.
+# It is used to indicate the location of document like canonical_url.
+html_baseurl = u'https://{ctx[github_user]}.github.io/{ctx[github_repo]}'
+html_baseurl = html_baseurl.format(ctx=html_context)
+
+# If given, this must be the name of an image file
+# (path relative to the configuration directory) that is the logo of the docs.
+# It is placed at the top of the sidebar;
+# its width should therefore not exceed 200 pixels. Default: None.
+html_logo = '_static/icon_64_bw.png'
+
+# If given, this must be the name of an image file
+# (path relative to the configuration directory) that is the
+# favicon of the docs. Modern browsers use this as the icon for tabs,
+# windows and bookmarks. It should be a Windows-style icon file (.ico),
+# which is 16x16 or 32x32 pixels large. Default: None.
+html_favicon = html_logo
+
+# 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 = {}
+
+# -- Extension configuration -------------------------------------------------
+
+# This value contains a list of modules to be mocked up.
+# This is useful when some external dependencies are
+# not met at build time and break the building process.
+# You may only specify the root package of the
+# dependencies themselves and omit the sub-modules:
+autodoc_mock_imports = [
+    "sgtk", "tank",
+    "Katana", "UI4",
+    "Qt",
+]
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True