{"id":15564109,"url":"https://github.com/dahlia/sphinx-fakeinv","last_synced_at":"2026-01-24T15:34:43.021Z","repository":{"id":66189075,"uuid":"68539883","full_name":"dahlia/sphinx-fakeinv","owner":"dahlia","description":"Generate fake Intersphinx inventory","archived":false,"fork":false,"pushed_at":"2016-09-18T19:46:59.000Z","size":22,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-05-12T19:21:25.583Z","etag":null,"topics":["docs","intersphinx","python","sphinx"],"latest_commit_sha":null,"homepage":"https://pypi.python.org/pypi/sphinx-fakeinv","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dahlia.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":"2016-09-18T18:36:04.000Z","updated_at":"2021-01-06T13:57:24.000Z","dependencies_parsed_at":"2023-03-29T03:48:34.693Z","dependency_job_id":null,"html_url":"https://github.com/dahlia/sphinx-fakeinv","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/dahlia/sphinx-fakeinv","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dahlia%2Fsphinx-fakeinv","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dahlia%2Fsphinx-fakeinv/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dahlia%2Fsphinx-fakeinv/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dahlia%2Fsphinx-fakeinv/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dahlia","download_url":"https://codeload.github.com/dahlia/sphinx-fakeinv/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dahlia%2Fsphinx-fakeinv/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28730321,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-24T10:24:43.181Z","status":"ssl_error","status_checked_at":"2026-01-24T10:24:36.112Z","response_time":89,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["docs","intersphinx","python","sphinx"],"created_at":"2024-10-02T16:36:38.860Z","updated_at":"2026-01-24T15:34:43.000Z","avatar_url":"https://github.com/dahlia.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"``sphinx-fakeinv``: Generate fake Intersphinx_ inventory\n=========================================================\n\n.. image:: https://badge.fury.io/py/sphinx-fakeinv.svg\n   :target: https://pypi.python.org/pypi/sphinx-fakeinv\n   :alt: Latest PyPI version\n\n.. image:: https://travis-ci.org/dahlia/sphinx-fakeinv.svg\n   :alt: Build Status\n   :target: https://travis-ci.org/dahlia/sphinx-fakeinv\n\nSometimes we create so tiny libraries that we don't need write docs using\nSphinx_ for them, but at the same time we may want to link them from\nother docs written using Sphinx.\n\nThis utility helps us to generate a fake ``objects.inv`` file\n(it's also known as Sphinx inventory) so that other Sphinx docs can link\nit through the Intersphinx_ extension.\n\n.. _Sphinx: http://www.sphinx-doc.org/\n.. _intersphinx: http://www.sphinx-doc.org/en/stable/ext/intersphinx.html\n\n\nInstallation\n------------\n\nIt's uploaded to PyPI_, so you can install it using ``pip``:\n\n.. code-block:: console\n\n   $ pip install sphinx-fakeinv\n\n.. _PyPI: https://pypi.python.org/pypi/sphinx-fakeinv\n\n\nUsage\n-----\n\nSuppose you've just written a tiny module named ``foobar``.  You can generate\na fake ``objects.inv`` for it by the following command:\n\n.. code-block:: console\n\n   $ sphinx-fakeinv foobar \u003e objects.inv\n\nThe ``shinx-fakeinv`` program automatically scans the submodules, subpackages,\nand classes/functions/exceptions/variables in all of scanned modules/packages.\n(Note that it's aware of ``__all__`` list if there's one.)\n\nIf you want to link it from other Sphinx docs, you need to manually add the url\nof it (of course you need to upload the generated fake ``objects.inv``\nsomewhere like gh-pages) to ``intersphinx_mapping`` configuration:\n\n.. code-block:: python\n\n   intersphinx_mapping = {\n       'foobar': (\n           'https://github.com/example/foobar',            # The project website\n           'https://example.github.io/foobar/objects.inv'  # The fake inventory\n       ),\n   }\n\nThat's done!  If you make references to ``foobar`` e.g.:\n\n.. code-block:: rst\n\n   If :mod:`foobar` module is available at runtime this function will uses\n   internally :func:`foobar.baz()`.\n\nLinks in the above example like ``foobar`` and ``foobar.baz()`` will refer\nto ``https://github.com/example/foobar``.\n\n\nAuthor and license\n------------------\n\nWritten by `Hong Minhee`__.  Distributed under GPLv3_ or later.\n\n__ https://hongminhee.org/\n.. _GPLv3: http://www.gnu.org/licenses/gpl-3.0.html\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdahlia%2Fsphinx-fakeinv","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdahlia%2Fsphinx-fakeinv","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdahlia%2Fsphinx-fakeinv/lists"}