sphinx_uml.pyreverse.sphinx_html_proxy module#

class sphinx_uml.pyreverse.sphinx_html_proxy.SphinxHtmlProxy(*args, **kwargs)[source]#

Bases: object

The SphinxHtmlProxy is a singleton in charge of returning the path of an HTML file corresponding to a class of the project being pyreversed.

set_sphinx_html_dir(sphinx_html_dir: Path | str)[source]#

Set the HTML Sphinx documentation directory.

Parameters:

sphinx_html_dir (Path | str) – The input directory. Example: ~/git/unext/docs/_build/html.

url(name: str = '') → str[source]#

Crafts an Sphinx URL depending on:

  • the HTML Sphinx directory (sphinx_html_dir);

  • the current module (module_name);

  • the current class (class_name);

  • the current method/attribute if any (see name).

Parameters:

name (str) – The current method/attribute name if any, "" otherwise.

Returns:

The resulting URL if any, None otherwise.