{"id":17800414,"url":"https://github.com/anntzer/sphinx-exhibit","last_synced_at":"2025-04-02T04:40:54.065Z","repository":{"id":145645544,"uuid":"146104138","full_name":"anntzer/sphinx-exhibit","owner":"anntzer","description":"Showcase examples in Sphinx-generated documentation.","archived":false,"fork":false,"pushed_at":"2021-12-22T12:43:20.000Z","size":105,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-02-07T19:20:04.640Z","etag":null,"topics":[],"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/anntzer.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2018-08-25T14:53:44.000Z","updated_at":"2021-12-22T12:43:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"2761ed1b-b385-40dd-ace1-f297c7930fea","html_url":"https://github.com/anntzer/sphinx-exhibit","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fsphinx-exhibit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fsphinx-exhibit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fsphinx-exhibit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/anntzer%2Fsphinx-exhibit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/anntzer","download_url":"https://codeload.github.com/anntzer/sphinx-exhibit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246758278,"owners_count":20828919,"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":[],"created_at":"2024-10-27T12:21:33.248Z","updated_at":"2025-04-02T04:40:54.046Z","avatar_url":"https://github.com/anntzer.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Showcase examples in Sphinx-generated documentation\n===================================================\n\nThis Sphinx extension introduces a ``.. exhibit::`` directive that can be used\nto generate one page per example in a Sphinx-generated documentation.\n\nActivate by adding ``\"sphinx_exhibit\"`` in the list of extensions in your\n``conf.py``.  Then, in one of your rst sources, add e.g.\n\n.. code-block:: rst\n\n   .. exhibit::\n      :srcdir: ../examples\n      :destdir: examples\n\n      this_example_comes_first.py\n      *.py\n\nThis will look up examples in ``srcdir`` (here, ``../examples``; relative to\nthe directory of the rst source), and create a rst example file for each of\nthe files listed, in ``destdir`` (again relative to the directory of the rst\nsource; defaults to ``.`` if not given). Globbing syntax can be used, and\nexamples listed before the glob will not be duplicated (but stay in front).\n\nMulti-block examples can use Sphinx-Gallery's syntax (\"special comments\"); or,\nlater blocks can just be introduced as top-level strings (i.e., as if they were\nmid-program docstrings).  The latter format is the default; Sphinx-Gallery's\nformat can be activated with the ``:syntax-style: sphinx-gallery`` option, or\nglobally in ``conf.py`` with ``exhibit_syntax_style = \"sphinx-gallery\"``).\nNote that this option depends on Sphinx-Gallery being installed (we reuse its\nparser in that case).\n\nBy default, output images are named ``{filename}-{block_idx}-{figure_idx}.png``\n(both indices start at zero).  Sphinx-Gallery-style numbering can likewise be\nactivated with ``:output-style: sphinx-gallery`` / ``exhibit_output_style =\n\"sphinx-gallery\"``.\n\nThe *topmost* docstring can contain the ``.. exhibit-skip::`` directive (which\ntakes no arguments and generates no output); if it is found there, the code\nwill not be run.\n\nThe list of examples that use a specific API element can be output using the\n``.. exhibit-backrefs::`` directive, whose syntax is\n\n.. code-block:: rst\n\n   .. exhibit-backrefs:: role qualified.name\n      :title: ...\n\nwhere the optional ``:title:`` is printed before the list if there is at least\none of them.\n\nDevelopment notes\n-----------------\n\nSphinx-Exhibit uses its ``__version__`` (which comes from ``git describe\n-a``) as the environment version reported to Sphinx.  To prevent invalidation\nof an environment generated with a previous ``__version__``, set the\n``SPHINX_EXHIBIT_ENV_VERSION`` environment variable to the desired value.  Of\ncourse, things may not go so well if the format of the data stored internally\nby Sphinx-Exhibit *did* change.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanntzer%2Fsphinx-exhibit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fanntzer%2Fsphinx-exhibit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fanntzer%2Fsphinx-exhibit/lists"}