sphinx_graph.vertex.Config

class sphinx_graph.vertex.Config(require_fingerprints: bool | None = None, layout: str | None = None, regex: Pattern[str] | None = None, require_parent: bool | None = None)[source]

Optional additional configuration for a vertex directive.

Parameters:
  • require_fingerprints – Whether parent links must provide fingerprints. If False (the default) then link fingerprints are checked if set, and ignored otherwise.

  • layout – which of the built-in layouts to use. The options are “subtle” (the default) or “transparent”.

  • regex – A regex pattern to check vertex IDs against.

  • require_parent – Whether the node MUST have at least one parent. This is used to disallow ‘orphan’ vertices.