{ "info": { "author": "Hong Minhee", "author_email": "hongminhee@member.fsf.org", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Framework :: Sphinx", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)", "Operating System :: OS Independent", "Programming Language :: Python :: 2.6", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3.3", "Programming Language :: Python :: 3.4", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Programming Language :: Python :: Implementation :: Stackless", "Topic :: Documentation :: Sphinx", "Topic :: Internet :: WWW/HTTP :: Indexing/Search", "Topic :: Software Development :: Documentation", "Topic :: Text Processing :: Indexing", "Topic :: Utilities" ], "description": "``sphinx-fakeinv``: Generate fake Intersphinx_ inventory\n=========================================================\n\nSometimes we create libraries so tiny 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 though 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/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 > 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", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "UNKNOWN", "keywords": "docs sphinx intersphinx", "license": "GPLv3 or later", "maintainer": null, "maintainer_email": null, "name": "sphinx-fakeinv", "package_url": "https://pypi.org/project/sphinx-fakeinv/", "platform": "UNKNOWN", "project_url": "https://pypi.org/project/sphinx-fakeinv/", "project_urls": { "Download": "UNKNOWN", "Homepage": "UNKNOWN" }, "release_url": "https://pypi.org/project/sphinx-fakeinv/1.0.0/", "requires_dist": null, "requires_python": null, "summary": "Generate fake Intersphinx inventory", "version": "1.0.0" }, "last_serial": 2349506, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "d2c2ca20101c3936c9dd67486535879f", "sha256": "b8a75be5368056308867e4da1f3b5ec758a1dc172109d5d87c3ec2bc3fc49bdc" }, "downloads": -1, "filename": "sphinx_fakeinv-1.0.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "d2c2ca20101c3936c9dd67486535879f", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 8214, "upload_time": "2016-09-18T19:35:01", "url": "https://files.pythonhosted.org/packages/1a/04/bf3ea9fac1857fce99d833081ee5aed76568c97f529c178c11ecfab906de/sphinx_fakeinv-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1cb65864e5f674e78589d0d23ae3f0ce", "sha256": "a97800b2ba4c57b31eb44636445b3a1a60f63606d371869efcbc83fdd2255183" }, "downloads": -1, "filename": "sphinx-fakeinv-1.0.0.tar.gz", "has_sig": true, "md5_digest": "1cb65864e5f674e78589d0d23ae3f0ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4175, "upload_time": "2016-09-18T19:34:57", "url": "https://files.pythonhosted.org/packages/82/dc/36e915fde5afdf91d0f5f26c2de25acb845e9e91e4f170ca3e27b8151bcd/sphinx-fakeinv-1.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d2c2ca20101c3936c9dd67486535879f", "sha256": "b8a75be5368056308867e4da1f3b5ec758a1dc172109d5d87c3ec2bc3fc49bdc" }, "downloads": -1, "filename": "sphinx_fakeinv-1.0.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "d2c2ca20101c3936c9dd67486535879f", "packagetype": "bdist_wheel", "python_version": "3.5", "requires_python": null, "size": 8214, "upload_time": "2016-09-18T19:35:01", "url": "https://files.pythonhosted.org/packages/1a/04/bf3ea9fac1857fce99d833081ee5aed76568c97f529c178c11ecfab906de/sphinx_fakeinv-1.0.0-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "1cb65864e5f674e78589d0d23ae3f0ce", "sha256": "a97800b2ba4c57b31eb44636445b3a1a60f63606d371869efcbc83fdd2255183" }, "downloads": -1, "filename": "sphinx-fakeinv-1.0.0.tar.gz", "has_sig": true, "md5_digest": "1cb65864e5f674e78589d0d23ae3f0ce", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4175, "upload_time": "2016-09-18T19:34:57", "url": "https://files.pythonhosted.org/packages/82/dc/36e915fde5afdf91d0f5f26c2de25acb845e9e91e4f170ca3e27b8151bcd/sphinx-fakeinv-1.0.0.tar.gz" } ] }