Skip to main content

Sphinx Extension to embed UMLet diagrams

Project description

Sphinx Extension for effordlessly embedding UMLet diagrams in your Sphinx document.

.. umlet-figure:: some_folder/some_diagram.uxf

It adds the umlet-image and umlet-figure directives. These are equivalent to the standard image and figure directives, but accept the path to a .uxf file and additional options to control exporting of the diagram to a suitable image format.

This extension is highly influenced by sphinxcontrib-drawio. Many thanks to the creator @modelmat !

Installation

  1. Make sure that UMLet works on your machine. Java runtime in the path is a prerequisite.

  2. Add the UMLet binary to $PATH. See below for more details and alternative solutions.

  3. pip install sphinxcontrib-umlet

  4. In your sphinx config.py, register it to the extensions to use, such as:

extensions = []
# ...
extensions.append("sphinxcontrib.umlet")
# ...

Usage

The extension can be used through the umlet-image directive. For example:

.. umlet-image:: some_diagram.uxf

There’s also a umlet-figure directive that mimics the figure directive:

.. umlet-figure:: some_diagram.uxf

    Some caption

The directives can be configured with option format to control the export of the specific UMLet diagram to a bitmap or vector image. This option controls the output file format of this specific directive, so it overrides the export format commonly used or commonly configured in the conf.py file.

  • Name: :format:

  • Default value: "png"

  • Possible Values: "png", "jpg", "svg" or "pdf"

Additionally, umlet-image accepts all of the options supported by the image directive. These options apply to the image as exported by UMLet. Similarly, umlet-figure accepts all options supported by the figure directive.

Configuration Options

These values are placed in the conf.py of your Sphinx project.

Binary Path

  • Name: umlet_binary_path

  • Default value: None

It is the path including the program’s name.

This config option allows for a specific override for the binary location. By default, this chooses the umlet.sh (resp. Umlet.exe) binary accessible in $PATH.

Default Output Format

  • Name: umlet_builder_export_format

  • Default value: {}

This config option controls the default export file format for each Sphinx builder.

It accepts a dictionary mapping builder names to image formats. The builder name should match the name of a Sphinx builder (e.g., "html", "latex"). Accepted values for the export format are "png", "jpg", "svg" and "pdf". If no format is set for a given builder, its preferred image format is used, that is, the first format listed in a builder’s supported image types that UMLet is capable of exporting to (eg. SVG for HTML, PDF for LaTeX).

Project details


Download files

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

Source Distribution

sphinxcontrib-umlet-1.0.2.tar.gz (11.8 kB view hashes)

Uploaded Source

Built Distribution

sphinxcontrib_umlet-1.0.2-py3-none-any.whl (6.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page