{"id":32178316,"url":"https://github.com/click-contrib/sphinx-click","last_synced_at":"2025-10-21T20:53:28.184Z","repository":{"id":19569658,"uuid":"87362999","full_name":"click-contrib/sphinx-click","owner":"click-contrib","description":"A Sphinx plugin to automatically document click-based applications","archived":false,"fork":false,"pushed_at":"2025-09-11T11:10:16.000Z","size":170,"stargazers_count":218,"open_issues_count":18,"forks_count":58,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-10-21T20:53:18.992Z","etag":null,"topics":["cli","click","sphinx","sphinx-extension","sphinx-plugin"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/click-contrib.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":"docs/contributing.rst","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2017-04-05T22:41:38.000Z","updated_at":"2025-10-06T12:41:44.000Z","dependencies_parsed_at":"2024-04-05T10:27:38.360Z","dependency_job_id":"f793b022-19d0-4ef5-a283-ee78e0e0153e","html_url":"https://github.com/click-contrib/sphinx-click","commit_stats":{"total_commits":142,"total_committers":30,"mean_commits":4.733333333333333,"dds":"0.31690140845070425","last_synced_commit":"aa0d5b7bcda183d20c7b98a9a1c9acf1e003af97"},"previous_names":[],"tags_count":42,"template":false,"template_full_name":null,"purl":"pkg:github/click-contrib/sphinx-click","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/click-contrib%2Fsphinx-click","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/click-contrib%2Fsphinx-click/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/click-contrib%2Fsphinx-click/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/click-contrib%2Fsphinx-click/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/click-contrib","download_url":"https://codeload.github.com/click-contrib/sphinx-click/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/click-contrib%2Fsphinx-click/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280333496,"owners_count":26312845,"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","status":"online","status_checked_at":"2025-10-21T02:00:06.614Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cli","click","sphinx","sphinx-extension","sphinx-plugin"],"created_at":"2025-10-21T20:53:24.381Z","updated_at":"2025-10-21T20:53:28.176Z","avatar_url":"https://github.com/click-contrib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"============\nsphinx-click\n============\n\n.. image:: https://github.com/click-contrib/sphinx-click/actions/workflows/ci.yaml/badge.svg\n    :target: https://github.com/click-contrib/sphinx-click/actions/workflows/ci.yaml\n    :alt: Build Status\n\n.. image:: https://readthedocs.org/projects/sphinx-click/badge/?version=latest\n    :target: https://sphinx-click.readthedocs.io/en/latest/?badge=latest\n    :alt: Documentation Status\n\n``sphinx-click`` is a `Sphinx`__ plugin that allows you to automatically extract\ndocumentation from a `Click-based`__ application and include it in your docs.\n\n__ http://www.sphinx-doc.org/\n__ http://click.pocoo.org/\n\nInstallation\n------------\n\nInstall the plugin using ``pip``:\n\n.. code-block:: shell\n\n   $ pip install sphinx-click\n\nAlternatively, install from source by cloning this repo then running ``pip``\nlocally:\n\n.. code-block:: shell\n\n   $ pip install .\n\nUsage\n-----\n\n.. important::\n\n   To document a Click-based application, both the application itself and any\n   additional dependencies required by that application **must be installed**.\n\nEnable the plugin in your Sphinx ``conf.py`` file:\n\n.. code-block:: python\n\n   extensions = ['sphinx_click']\n\nOnce enabled, you can now use the plugin wherever necessary in the\ndocumentation.\n\n.. code-block::\n\n   .. click:: module:parser\n      :prog: hello-world\n      :nested: full\n\nDetailed information on the various options available is provided in the\n`documentation \u003chttps://sphinx-click.readthedocs.io\u003e`_.\n\nAlternative\n-----------\n\nThis plugin is perfect to document a Click-based CLI in Sphinx, as it properly\nrenders the help screen and its options in nice HTML with deep links and\nstyling.\n\nHowever, if you are looking to document the source code of a Click-based CLI,\nand the result of its execution, you might want to check out `click-extra`__.\nThe latter provides the ``.. click:example::`` and ``.. click:run::`` Sphinx\ndirectives so you can `capture and render, with full colors, the result of your\nCLI in your documentation`__.\n\n__ https://github.com/kdeldycke/click-extra/\n__ https://kdeldycke.github.io/click-extra/sphinx.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclick-contrib%2Fsphinx-click","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclick-contrib%2Fsphinx-click","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclick-contrib%2Fsphinx-click/lists"}