wwfxuk / tk-katana Goto Github PK

Describe the bug
Hooks scripts files currently not documented:

• All scripts files are not present
• Generated pages are currently empty

To Reproduce
Steps to reproduce the behavior: see script in description of #9

Expected behavior
Documentations generated successfully for all hooks Python script files

Additional context
See WARNING: invalid signature for automodule near the bottom of https://api.travis-ci.com/v3/job/207182990/log.txt

Document using tk-katana as an engine after install, similar to this in tk-natron

New "How To" page to include things like:

• Project structure
• Where things should go
• How to update stuff and test it, which also then leads to...

Is your feature request related to a problem? Please describe.
Document tk-doc-generator and just-the-docs during CI Docs PR #6 and why it was not used in the end

Describe the solution you'd like
New reference/tkdocgenerator.rst page as it's not a "How to" or "Getting Started".

Describe the bug
A clear and concise description of what the bug is.

To Reproduce
tk-multi-publish2.yml:
settings.tk-multi-publish2.katana.asset_step:
collector: "{self}/collector.py:{engine}/tk-multi-publish2/basic/collector.py"

Hello, thank you very much for your development and sharing. But I have a problem: After Configuring with your tk-katana, I find that the collector. py is missing. Where is this file? Or do I need to develop it myself?

Is your feature request related to a problem? Please describe.
Write up on how to generate the documentation and when developing, forcing the CI to generate pages

Describe the solution you'd like
New howto/makedocs.rst outlining setting up venv and modifying .travis.yml (and why generally it is not a good idea)

Additional context

rm -rf ./docs/api/ ./docs/_build/
source /path/to/docs/venv/bin/activate
sphinx-apidoc -o ./docs/api --separate --no-toc ./
sphinx-apidoc -o ./docs/api/hooks --separate --tocfile index ./hooks
sphinx-build ./docs ./docs/_build

Reference page for info.yml configurations and potential future configuration options we might add in the future

Reference page on what the hooks are currently doing and how they are suppose to be integrated (as well as some technical background on how Shotgun hooks work in general)