Metadata-Version: 2.0
Name: sphinxcontrib-visio
Version: 2.1.2
Summary: Sphinx "visio" extension; embed MS-Visio file (.vsd, .vsdx)
Home-page: https://github.com/visio2img/sphinxcontrib-visio
Author: Takeshi KOMIYA
Author-email: i.tkomiya@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Win32 (MS Windows)
Classifier: Framework :: Sphinx :: Extension
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Topic :: Documentation
Classifier: Topic :: Documentation :: Sphinx
Classifier: Topic :: Multimedia :: Graphics :: Graphics Conversion
Classifier: Topic :: Office/Business :: Office Suites
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Dist: Sphinx (>=1.0.0)
Requires-Dist: sphinxcontrib-imagehelper
Requires-Dist: visio2img (>=1.2.0)

===================
sphinxcontrib-visio
===================

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

.. image:: https://pypip.in/v/sphinxcontrib-visio/badge.png
   :target: https://pypi.python.org/pypi/sphinxcontrib-visio/
   :alt: Latest PyPI version

.. image:: https://pypip.in/d/sphinxcontrib-visio/badge.png
   :target: https://pypi.python.org/pypi/sphinxcontrib-visio/
   :alt: 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

.. _pywin32: http://sourceforge.net/projects/pywin32/files/pywin32/
.. _visio2img: https://pypi.python.org/pypi/visio2img

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


