{"id":13994479,"url":"https://github.com/sphinx-contrib/plantuml","last_synced_at":"2025-04-04T13:09:45.840Z","repository":{"id":42501924,"uuid":"105162155","full_name":"sphinx-contrib/plantuml","owner":"sphinx-contrib","description":null,"archived":false,"fork":false,"pushed_at":"2024-05-22T13:34:53.000Z","size":195,"stargazers_count":112,"open_issues_count":21,"forks_count":40,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-05-22T13:47:20.654Z","etag":null,"topics":["plantuml","python","sphinx-extension"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-2-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sphinx-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-28T14:57:19.000Z","updated_at":"2024-06-18T14:22:01.215Z","dependencies_parsed_at":"2023-02-09T15:30:29.068Z","dependency_job_id":"65b054fc-ff83-4230-8215-52cd44e62685","html_url":"https://github.com/sphinx-contrib/plantuml","commit_stats":{"total_commits":185,"total_committers":17,"mean_commits":"10.882352941176471","dds":"0.16216216216216217","last_synced_commit":"f0897da727e548e4ec69784a2028d06cd324a427"},"previous_names":[],"tags_count":37,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fplantuml","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fplantuml/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fplantuml/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sphinx-contrib%2Fplantuml/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sphinx-contrib","download_url":"https://codeload.github.com/sphinx-contrib/plantuml/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247180583,"owners_count":20897252,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["plantuml","python","sphinx-extension"],"created_at":"2024-08-09T14:02:53.797Z","updated_at":"2025-04-04T13:09:45.815Z","avatar_url":"https://github.com/sphinx-contrib.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"PlantUML for Sphinx\n===================\n\nInstallation\n------------\n\n.. code-block::\n\n   pip install sphinxcontrib-plantuml\n\nUsage\n-----\n\nAdd ``sphinxcontrib.plantuml`` to your extensions list in your ``conf.py``:\n\n\n.. code-block:: python\n\n   extensions = [\n       'sphinxcontrib.plantuml',\n   ]\n\nYou may also need to specify the plantuml command in your **conf.py**:\n\n.. code-block:: python\n\n   plantuml = 'java -jar /path/to/plantuml.jar'\n\nInstead, you can install a wrapper script in your PATH:\n\n.. code-block:: console\n\n   % cat \u003c\u003cEOT \u003e /usr/local/bin/plantuml\n   #!/bin/sh -e\n   java -jar /path/to/plantuml.jar \"$@\"\n   EOT\n   % chmod +x /usr/local/bin/plantuml\n\nThen, write PlantUML text under the ``.. uml::`` (or ``.. plantuml::``)\ndirective::\n\n    .. uml::\n\n       Alice -\u003e Bob: Hi!\n       Alice \u003c- Bob: How are you?\n\nor specify path to an external PlantUML file::\n\n    .. uml:: external.uml\n\nYou can specify ``height``, ``width``, ``scale`` and ``align``::\n\n    .. uml::\n       :scale: 50 %\n       :align: center\n\n       Foo \u003c|-- Bar\n\nYou can also specify a caption::\n\n    .. uml::\n       :caption: Caption with **bold** and *italic*\n       :width: 50mm\n\n       Foo \u003c|-- Bar\n\nFor details, please see PlantUML_ documentation.\n\n.. _PlantUML: http://plantuml.com/\n\nConfiguration\n-------------\n\nplantuml\n  Path to plantuml executable. (default: 'plantuml')\n\nplantuml_output_format\n  Type of output image for HTML renderer. (default: 'png')\n\n  :png: generate only .png inside \u003c/img\u003e\n  :svg: generate .svg inside \u003cobject/\u003e with .png inside \u003c/img\u003e as a fallback\n  :svg_img: generate only .svg inside \u003cimg/\u003e (`browser support \u003csvg_img_\u003e`_)\n  :svg_obj: generate only .svg inside \u003cobject/\u003e (`browser support \u003csvg_obj_\u003e`_)\n  :none: do not generate any images (ignore uml directive)\n\n  When svg is inside \u003cobject/\u003e it will always render full size, possibly bigger\n  than the container. When svg is inside \u003cimg/\u003e it will respect container size\n  and scale if necessary.\n\nplantuml_latex_output_format\n  Type of output image for LaTeX renderer. (default: 'png')\n\n  :eps: generate .eps (not supported by `pdflatex`)\n  :pdf: generate .eps and convert it to .pdf (requires `epstopdf`)\n  :png: generate .png\n  :tikz: generate .latex in the TikZ format\n  :none: do not generate any images (ignore uml directive)\n\n  Because embedded png looks pretty bad, it is recommended to choose `pdf`\n  for `pdflatex` or `eps` for `platex`.\n\nplantuml_epstopdf\n  Path to epstopdf executable. (default: 'epstopdf')\n\n.. _svg_img: https://caniuse.com/svg-img\n.. _svg_obj: https://caniuse.com/svg\n\nplantuml_syntax_error_image\n  Should plantuml generate images with render errors. (default: False)\n\nplantuml_cache_path\n  Directory where image cache is stored. (default: '_plantuml')\n\nplantuml_batch_size\n  **(EXPERIMENTAL)**\n  Run plantuml command per the specified number of images. (default: 1)\n\n  If enabled, plantuml documents will be first written to the cache directory,\n  and rendered in batches. This eliminates bootstrapping overhead of Java\n  runtime and allows plantuml to leverage multiple CPU cores.\n\n  To enable batch rendering, set the size to 100-1000.\n\nDeveloping\n----------\n\nInstall the python test dependencies with\n\n.. code-block::\n\n   pip install sphinxcontrib-plantuml[test]\n\nIn addition the following non-python dependencies are required in order to run the tests:\n\n* `latexmk`\n* `plantuml`\n* `texlive`\n* `texlive-font-utils`\n* `texlive-latex-extra`\n\nThe tests can be executed using `pytest`\n\n.. code-block::\n\n    pytest\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fplantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsphinx-contrib%2Fplantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsphinx-contrib%2Fplantuml/lists"}