sphinx_uml package

Subpackages

• sphinx_uml.pyreverse package
  • Submodules
    • sphinx_uml.pyreverse.cli module
      • run_pyreverse2()
    • sphinx_uml.pyreverse.dot_printer module
      • DotPrinter
    • sphinx_uml.pyreverse.main module
      • ParsePyreverseArgs
      • Run
    • sphinx_uml.pyreverse.sphinx_html_proxy module
      • SphinxHtmlProxy
  • Module contents

Submodules

• sphinx_uml.singleton module
  • Singleton
    • Singleton.s_instances
• sphinx_uml.uml_generate_directive module
  • UMLGenerateDirective
    • UMLGenerateDirective.final_argument_whitespace
    • UMLGenerateDirective.has_content
    • UMLGenerateDirective.html_root_dir()
    • UMLGenerateDirective.option_spec
    • UMLGenerateDirective.optional_arguments
    • UMLGenerateDirective.required_arguments
    • UMLGenerateDirective.run()
  • UmlNode
    • UmlNode.from_dot()
    • UmlNode.from_pyreverse()
    • UmlNode.to_dot()
  • guess_svg_basename()

Module contents

class sphinx_uml.UMLGenerateDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)

Bases: SphinxDirective

UML directive to generate a pyreverse diagram

final_argument_whitespace = True

May the final argument contain whitespace?

has_content = False

May the directive have content?

html_root_dir() → Path

Crafts the HTML prefix to move from the current HTML to the HTML root directory.

Returns:

The corresponding relative Path instance.

Example

Assume that:

• the documentation is built in: "~/git/sphinx-uml/docs";

• the current document is; "~/git/sphinx-uml/docs/users/examples.rst";

Then, the returned value is "../". As the HTML hierarchy follows the RST hierarchy, we use this prefix to setup our SphinxHtmlProxy.

option_spec: ClassVar[dict[str, Callable[[str], Any]]] = {'caption': <function unchanged>, 'classes': <function flag>, 'packages': <function flag>}

Mapping of option names to validator functions.

optional_arguments = 0

Number of optional arguments after the required arguments.

required_arguments = 1

Number of required directive arguments.

run()

To test this extension, as a developer:

To test this pyreverse2, called by this extension: