shotgunsoftware / tk-doc-generator

ShotGrid Developer Documentation Generation

ShotGrid Toolkit Documentation Generator

This repository makes it easy to generate documentation for ShotGrid and Toolkit related repositories.

When do I need this?

If you are releasing Toolkit apps, engines, frameworks or any other ShotGrid related integrations, tools or APIs, this repository can accelerate your documentation process.

What does it do?

You include this repository as a git submodule in your repository and it will convert markdown and sphinx documentation into a website with the same look and feel as developer.shotgunstudio.com. It makes the process of generating reference documentation, guides, FAQs and tutorials easy.

How do I use it?

Check out the documentation:

• How to set up the doc generator with your repository.

• How to author and release documentation.

Examples of documentation

Apart from the documentation links above, a great way to understand a system is to look at how it is being used in practice. Below are some examples of what documentation sites generated with the generator looks like, along with their source markdown:

• This repository's documentation: [docs] / [source].

• The ShotGrid developer site: [docs] / [source].