{ "info": { "author": "Colin Kennedy", "author_email": "colinvfx@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: Microsoft :: Windows", "Operating System :: POSIX", "Operating System :: Unix", "Programming Language :: Python", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", "Topic :: Utilities" ], "description": "========\nOverview\n========\n\n\n\nsphinx-code-include is an extension for Sphinx that lets you render\nsource-code of any class or function directly into your Sphinx\ndocumentation using only as string.\n\n* Free software: BSD 2-Clause License\n\nExample\n\n::\n\n .. code-include :: :func:`os.path.join`\n\nThis code-include block renders as: (theme is sphinx_rtd_theme)\n\n.. image :: https://user-images.githubusercontent.com/10103049/67256848-f7422380-f43d-11e9-857a-434ba7bf579f.jpg\n\nAs long as the string you've chosen is either\n\n- is importable\n- is coming from a project that has `sphinx.ext.viewcode`_ enabled\n\nthen code-include can find it and render it in your documentation.\n\nInstallation\n============\n\n::\n\n pip install sphinx-code-include\n\nYou can also install the in-development version with::\n\n pip install https://github.com/ColinKennedy/sphinx-code-include/archive/master.zip\n\n\nDocumentation\n=============\n\n\nhttps://sphinx-code-include.readthedocs.io/\n\n\nDevelopment\n===========\n\nTo run the all tests run::\n\n tox\n\n.. _sphinx.ext.viewcode: https://www.sphinx-doc.org/en/master/usage/extensions/viewcode.html\n\n\nChangelog\n=========\n\n1.1.1 (2019-10-26)\n------------------\n\n* Fixed the requirements of the PyPI package\n\n\n1.1.0 (2019-10-26)\n------------------\n\n* Added :link-to-source: and :link-to-documentation: options\n* Added support for the :obj: tag (which can be used in place of :class:, :func:, or :meth:)\n\n\n1.0.0 (2019-10-20)\n------------------\n\n* First release on PyPI.\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/ColinKennedy/sphinx-code-include", "keywords": "Sphinx,code-include,source-code,source code,include", "license": "BSD-2-Clause", "maintainer": "", "maintainer_email": "", "name": "sphinx-code-include", "package_url": "https://pypi.org/project/sphinx-code-include/", "platform": "", "project_url": "https://pypi.org/project/sphinx-code-include/", "project_urls": { "Changelog": "https://sphinx-code-include.readthedocs.io/en/latest/changelog.html", "Documentation": "https://sphinx-code-include.readthedocs.io/", "Homepage": "https://github.com/ColinKennedy/sphinx-code-include", "Issue Tracker": "https://github.com/ColinKennedy/sphinx-code-include/issues" }, "release_url": "https://pypi.org/project/sphinx-code-include/1.1.1/", "requires_dist": [ "beautifulsoup4 (>=4.8)", "six (>=1.12)", "sphinx (>=1.3)" ], "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "summary": "Include source code from any Sphinx project using only its import path", "version": "1.1.1", "yanked": false, "yanked_reason": null }, "last_serial": 6035549, "releases": { "1.0.0": [ { "comment_text": "", "digests": { "md5": "06f0c61c36e69e11ffc1c04fb2e974d4", "sha256": "3ea004bf5d0c52b9b4fd0304c2faa2e4612fada150e97f7139c460b9987e7891" }, "downloads": -1, "filename": "sphinx_code_include-1.0.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "06f0c61c36e69e11ffc1c04fb2e974d4", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 11767, "upload_time": "2019-10-23T03:56:58", "upload_time_iso_8601": "2019-10-23T03:56:58.899201Z", "url": "https://files.pythonhosted.org/packages/e9/39/1956a97189b2e2c6db059903e4dcffef0a396d74476fe5bd87e7b9f9a2a4/sphinx_code_include-1.0.0-py2.py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "6a47a92de2dfc155983abdf7ac45cdc9", "sha256": "5c1cc1ecae4f7ad66d6b6b5f08887976da7399153f2c09da7ccab91faab6c7b8" }, "downloads": -1, "filename": "sphinx-code-include-1.0.0.tar.gz", "has_sig": false, "md5_digest": "6a47a92de2dfc155983abdf7ac45cdc9", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 231262, "upload_time": "2019-10-23T03:55:32", "upload_time_iso_8601": "2019-10-23T03:55:32.658297Z", "url": "https://files.pythonhosted.org/packages/e1/89/458dc3b07f9c111aedd6bc80440d0655967bdadb94e41287f1658f96e331/sphinx-code-include-1.0.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.1.0": [ { "comment_text": "", "digests": { "md5": "635ad1c912715d49f7f23ce196821590", "sha256": "442fd2d4b92c64eeb7ed2ed8b67ef24509b3793c625676e3ae20d47b10ad83fe" }, "downloads": -1, "filename": "sphinx_code_include-1.1.0-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "635ad1c912715d49f7f23ce196821590", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 13095, "upload_time": "2019-10-27T00:57:23", "upload_time_iso_8601": "2019-10-27T00:57:23.337914Z", "url": "https://files.pythonhosted.org/packages/8e/e9/71503fe00e8857dce730af83f689effe5fec676277d65dbfd4b0e21110e6/sphinx_code_include-1.1.0-py2.py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "875c1a15067aa83bb32d4f1c1360b414", "sha256": "7818c426ad8539205bb4fbf0d25f83ccfd52f3f016dd2f5f2c5a0e5ec28838f7" }, "downloads": -1, "filename": "sphinx-code-include-1.1.0.tar.gz", "has_sig": false, "md5_digest": "875c1a15067aa83bb32d4f1c1360b414", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 233192, "upload_time": "2019-10-27T00:57:25", "upload_time_iso_8601": "2019-10-27T00:57:25.225516Z", "url": "https://files.pythonhosted.org/packages/53/34/76f3702dd762dd033ce7e2cfcb3f708a2a1f20052e4e8e16cafab63f2eae/sphinx-code-include-1.1.0.tar.gz", "yanked": false, "yanked_reason": null } ], "1.1.1": [ { "comment_text": "", "digests": { "md5": "60a7b4a63ff2b8d4ee65a33a44c7a2ae", "sha256": "8c7d680fabb9fe45a74d036c967a61ef574fe1bd49d1539a74f52b9abbe50207" }, "downloads": -1, "filename": "sphinx_code_include-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "60a7b4a63ff2b8d4ee65a33a44c7a2ae", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 13184, "upload_time": "2019-10-27T01:10:57", "upload_time_iso_8601": "2019-10-27T01:10:57.270340Z", "url": "https://files.pythonhosted.org/packages/89/bf/95e6eb1b9a5cf502684006c9ac8a11f7d543a95a45856dcaf8f7bf9b31f1/sphinx_code_include-1.1.1-py2.py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "657c57074a0371057fe5b7a6565836f2", "sha256": "1bd022a18571fe9245ad342a1bd83ebf69ed0aeca3508abc7498f8f4701952a3" }, "downloads": -1, "filename": "sphinx-code-include-1.1.1.tar.gz", "has_sig": false, "md5_digest": "657c57074a0371057fe5b7a6565836f2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 233239, "upload_time": "2019-10-27T01:10:59", "upload_time_iso_8601": "2019-10-27T01:10:59.208494Z", "url": "https://files.pythonhosted.org/packages/f4/c7/8725a6f6c384f576ac95cf7fa391065cc63b585503598a31cf97008fa3b1/sphinx-code-include-1.1.1.tar.gz", "yanked": false, "yanked_reason": null } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "60a7b4a63ff2b8d4ee65a33a44c7a2ae", "sha256": "8c7d680fabb9fe45a74d036c967a61ef574fe1bd49d1539a74f52b9abbe50207" }, "downloads": -1, "filename": "sphinx_code_include-1.1.1-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "60a7b4a63ff2b8d4ee65a33a44c7a2ae", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 13184, "upload_time": "2019-10-27T01:10:57", "upload_time_iso_8601": "2019-10-27T01:10:57.270340Z", "url": "https://files.pythonhosted.org/packages/89/bf/95e6eb1b9a5cf502684006c9ac8a11f7d543a95a45856dcaf8f7bf9b31f1/sphinx_code_include-1.1.1-py2.py3-none-any.whl", "yanked": false, "yanked_reason": null }, { "comment_text": "", "digests": { "md5": "657c57074a0371057fe5b7a6565836f2", "sha256": "1bd022a18571fe9245ad342a1bd83ebf69ed0aeca3508abc7498f8f4701952a3" }, "downloads": -1, "filename": "sphinx-code-include-1.1.1.tar.gz", "has_sig": false, "md5_digest": "657c57074a0371057fe5b7a6565836f2", "packagetype": "sdist", "python_version": "source", "requires_python": ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*", "size": 233239, "upload_time": "2019-10-27T01:10:59", "upload_time_iso_8601": "2019-10-27T01:10:59.208494Z", "url": "https://files.pythonhosted.org/packages/f4/c7/8725a6f6c384f576ac95cf7fa391065cc63b585503598a31cf97008fa3b1/sphinx-code-include-1.1.1.tar.gz", "yanked": false, "yanked_reason": null } ], "vulnerabilities": [] }