This extension interacts with the Visuals API.

the Visuals API should make it easier to integrate visuals into your ReStructuredText documents. The process of creating visuals, like screenshots, clashes with the documentation workflow. The workflows, processes, and tooling for image creation and writing are very different, so the Visuals API makes it easier to tackle each process and workflow separately. Eventually, we'd like to make it possible to automate the creation of visuals, like screenshots, wherever possible. the Visuals API will be the entry point for such automation.

• Sphinx 1.3

Possibly add a visual domain to add things like: - visual:screenshot: - visual:toolbar: - visual:button: - visual:icon:

These would document a visual element in directives, and link to the description in roles.

There might also be a simple way to create substitutions for specific elements automatically to include miniatures of buttons and icons and such... See the visual role for more thinking.

The <short description> acts like an id for the image. It should be unique per file.

The content block should include additional directives. It could even include the directives .. caption:: and .. legend:: if they make sense for this visual. If a caption and/or legend is included, this acts like a figure directive instead of an image directive.

Everything else will be passed to to get a URI that can be embedded, probably via oEmbed.

The TYPO3 Association funded the initial development of this.