{"id":13941112,"url":"https://github.com/pygobject/pgi-docgen","last_synced_at":"2025-10-28T05:49:43.850Z","repository":{"id":8022259,"uuid":"9431280","full_name":"pygobject/pgi-docgen","owner":"pygobject","description":"API Documentation Generator for PyGObject","archived":false,"fork":false,"pushed_at":"2025-03-06T19:59:50.000Z","size":4999,"stargazers_count":132,"open_issues_count":48,"forks_count":36,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-07-20T04:55:33.045Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://lazka.github.io/pgi-docs/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pygobject.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":"2013-04-14T16:02:16.000Z","updated_at":"2025-06-04T07:57:41.000Z","dependencies_parsed_at":"2024-02-24T11:31:54.522Z","dependency_job_id":"78b85ea1-13dd-42e9-96c4-51f231e373cc","html_url":"https://github.com/pygobject/pgi-docgen","commit_stats":{"total_commits":811,"total_committers":5,"mean_commits":162.2,"dds":"0.012330456226880449","last_synced_commit":"cf60c356733d5646c5c7ed0b876c3c4d866b9555"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/pygobject/pgi-docgen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygobject%2Fpgi-docgen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygobject%2Fpgi-docgen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygobject%2Fpgi-docgen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygobject%2Fpgi-docgen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pygobject","download_url":"https://codeload.github.com/pygobject/pgi-docgen/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pygobject%2Fpgi-docgen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281391762,"owners_count":26492903,"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-28T02:00:06.022Z","response_time":60,"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":[],"created_at":"2024-08-08T02:01:11.429Z","updated_at":"2025-10-28T05:49:43.802Z","avatar_url":"https://github.com/pygobject.png","language":"Python","readme":".. image:: https://codecov.io/gh/pygobject/pgi-docgen/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/pygobject/pgi-docgen\n\nWhat is this?\n=============\n\nA tool to create Sphinx documentation for GI modules using Python\nintrospection.\n\n``pgi-docgen create`` introspects the GI module, pulls in the GIR docs and\ncreates a Sphinx environment.\n\n``pgi-docgen build`` builds HTML documentation using Sphinx.\n\nHow do I get started?\n---------------------\n\n::\n\n    poetry install\n    poetry shell\n    # API docs for Gtk/Gst:\n    ./tools/build.sh Gtk-3.0 Gst-1.0\n\nThe resulting docs can be found in ``_docs/_build``\n\n\nHow do I build docs for private libraries?\n------------------------------------------\n\nThe following creates docs for the in gnome-music included libgd::\n\n    XDG_DATA_DIRS=$XDG_DATA_DIRS:/usr/share/gnome-music/ \\\n    GI_TYPELIB_PATH=/usr/lib/x86_64-linux-gnu/gnome-music/girepository-1.0/ \\\n    LD_LIBRARY_PATH=/usr/lib/x86_64-linux-gnu/gnome-music/ ./build.sh Gd-1.0\n\n\nIntersphinx\n-----------\n\nThere are two ways to reference the online API reference from sphinx\ngenerated documentation:\n\n1) Including the sidebar (needs JavaScript)\n\n   ::\n\n        intersphinx_mapping = {\n            'gtk': ('https://lazka.github.io/pgi-docs/#Gtk-3.0/',\n                    'https://lazka.github.io/pgi-docs/Gtk-3.0/objects.inv'),\n        }\n\n2) Without the sidebar\n\n   ::\n\n        intersphinx_mapping = {\n            'gtk': ('https://lazka.github.io/pgi-docs/Gtk-3.0', None),\n        }\n\n\nLicenses\n--------\n\nEverything in the ``pgidocgen/gen/data/theme`` sub directory:\n\n    https://github.com/rtfd/readthedocs.org\n\n    MIT License\n\nFonts in ``pgidocgen/gen/data/theme/static/fonts``\n\n    Lato:\n        https://www.latofonts.com\n\n        SIL Open Font License 1.1\n\n    DejaVu Sans Mono:\n        https://dejavu-fonts.github.io/\n\n        Public Domain\n\n    FontAwesome:\n        https://fontawesome.io\n\n        SIL OFL 1.1\n\n``pgidocgen/gen/data/ext/devhelp_fork.py``\n\n    https://bitbucket.org/birkenfeld/sphinx/\n\n    BSD\n\n``pgidocgen/gen/data/index/jquery-2.2.0.min.js``\n\n    https://jquery.org/\n\n    MIT License\n\nEverything else:\n\n    GNU Lesser General Public License 2.1 or later\n","funding_links":[],"categories":["Python"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpygobject%2Fpgi-docgen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpygobject%2Fpgi-docgen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpygobject%2Fpgi-docgen/lists"}