Skip to main content

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:

pagenumber

Page number of the page to embed to document.

sheettext

Title of the sheet to embed to document.

.. 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:

pagenumber

Page number of the page to embed to document.

nametext

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

Download files

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

Source Distribution

sphinxcontrib-visio-2.1.2.tar.gz (7.7 kB view hashes)

Uploaded source

Built Distribution

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page