Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

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

Project description

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

Latest PyPI version Number of PyPI downloads

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

Release history Release notifications

This version
History Node

2.1.2

History Node

2.0.0

History Node

1.1.0

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

History Node

0.9.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib_visio-2.1.2-py2.py3-none-any.whl (5.9 kB) Copy SHA256 hash SHA256 Wheel 2.7 May 18, 2016
sphinxcontrib-visio-2.1.2.tar.gz (7.7 kB) Copy SHA256 hash SHA256 Source None May 18, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page