skip to navigation
skip to content

sphinxcontrib-visio 2.1.2

Sphinx "visio" extension; embed MS-Visio file (.vsd, .vsdx)

sphinxcontrib-visio is a sphinx extension. It embeds MS-Visio file (.vsd, .vsdx) to your documents.

Requirements

  • Python 2.7, 3.3 or later
  • Sphinx 1.0 or later
  • pywin32
  • visio2img 1.2.0 or later
  • Microsoft Visio

Setup

  1. Install pywin32 manually

  2. Install sphinxcontrib-visio package:

    $ pip install sphinxcontrib-visio
    

And then, append sphinxcontrib.visio to conf.py of your Sphinx project:

# extensions = []
extensions = ['sphinxcontrib.visio']

Directives

.. visio-image: [filename]

This directive inserts MS-Visio image into the document. It inserts image from visio file named as filename.

Examples:

.. visio-image:: foo.vsdx

The visio-image directive supports all of the options of the image directive.

In addition, the following options are recognized:

page : number
Page number of the page to embed to document.
sheet : text

Title of the sheet to embed to document.

Note

name is deprecated on 2.0.0

.. visio-figure: [filename]

This directive inserts MS-Visio image into the document and its caption. It inserts image from visio file named as filename.

Examples:

.. visio-figure:: foo.vsdx

   caption of foo

The visio-figure directive supports all of the options of the figure directive.

In addition, the following options are recognized:

page : number
Page number of the page to embed to document.
name : text
Title of the page to embed to document.

Author

Yassu <mathyassu@gmail.com>

Maintainer

Takeshi KOMIYA <i.tkomiya@gmail.com>

License

Apache License 2.0

 
File Type Py Version Uploaded on Size
sphinxcontrib-visio-2.1.2.tar.gz (md5) Source 2016-05-18 7KB
sphinxcontrib_visio-2.1.2-py2.py3-none-any.whl (md5) Python Wheel 2.7 2016-05-18 5KB