{ "info": { "author": "Fabrice Salvaire", "author_email": "fabrice.salvaire@orange.fr", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Software Development :: Documentation", "Topic :: Utilities" ], "description": ".. |Pypi Version| image:: https://img.shields.io/pypi/v/sphinxcontrib-getthecode.svg\n :target: https://pypi.python.org/pypi/sphinxcontrib-getthecode\n :alt: sphinxcontrib-getthecode last version\n\n.. |Pypi License| image:: https://img.shields.io/pypi/l/sphinxcontrib-getthecode.svg\n :target: https://pypi.python.org/pypi/sphinxcontrib-getthecode\n :alt: sphinxcontrib-getthecode license\n\n.. |Pypi Python Version| image:: https://img.shields.io/pypi/pyversions/sphinxcontrib-getthecode.svg\n :target: https://pypi.python.org/pypi/sphinxcontrib-getthecode\n :alt: sphinxcontrib-getthecode python version\n\n.. |Python| replace:: Python\n.. _Python: http://python.org\n\n.. |PyPI| replace:: PyPI\n.. _PyPI: https://pypi.python.org/pypi\n\n.. |Sphinx| replace:: Sphinx\n.. _Sphinx: http://sphinx-doc.org\n\n==============================\n GetTheCode plugin for Sphinx\n==============================\n\n|Pypi License|\n|Pypi Python Version|\n\n|Pypi Version|\n\nThis plugin implements an enhanced ``literalinclude`` directive for the `Sphinx`_ Documentation Generator.\n\nFor a demo, look at `Pyterate `_.\n\nAuthored by `Fabrice Salvaire `_.\n\nSource code is hosted at https://github.com/FabriceSalvaire/sphinx-getthecode\n\nInstallation\n------------\n\nUsing ``pip``:\n\n.. code-block:: bash\n\n pip install sphinxcontrib-getthecode\n\nElse clone the Git repository:\n\n.. code-block:: sh\n\n git clone git@github.com:FabriceSalvaire/sphinx-getthecode\n\nthen install the plugin using:\n\n.. code-block:: bash\n\n python setup.py install\n\nUsage\n-----\n\nTo load the plugin, you have to add it in your ``conf.py`` file.\n\n.. code-block:: python\n\n extensions = [\n ...\n 'sphinxcontrib.getthecode',\n ]\n\nDirectives\n----------\n\nThis plugin implements a directive ``getthecode`` which is equivalent to the ``literalinclude``\ndirective, but it adds a header before the ``pre`` element. This header contains the file name and\na link to download the file.\n\n.. code-block:: ReST\n\n .. getthecode:: example.py\n :language: python3\n :hidden: ### optional, add a class highlight-hidden\n\nwill result in:\n\n.. code-block:: html\n\n
\n
\n \t\n
\n
\n \t
\n \t
\n\t    ...\n    \t    
\n \t
\n
\n
\n\nYou can find in the ``static`` directory an example of **CSS stylesheet** and a **Javascript code to show/hide the code**.\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-getthecode", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/FabriceSalvaire/sphinx-getthecode", "keywords": "sphinx extension literalinclude", "license": "GPLv3", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-getthecode", "package_url": "https://pypi.org/project/sphinxcontrib-getthecode/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-getthecode/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-getthecode", "Homepage": "https://github.com/FabriceSalvaire/sphinx-getthecode" }, "release_url": "https://pypi.org/project/sphinxcontrib-getthecode/1.0.0/", "requires_dist": [ "Sphinx (>=0.6)" ], "requires_python": "", "summary": "Sphinx getthecode extension", "version": "1.0.0" }, "last_serial": 3366080, "releases": { "0.1dev-20140921": [ { "comment_text": "", "digests": { "md5": "dec11bbe73f9e5dc9a86f850482d30e3", "sha256": "ef2495098b13aa699ea2273998a3e328e2650355781f3df29a1bc44c8429d46b" }, "downloads": -1, "filename": "sphinxcontrib-getthecode-0.1dev-20140921.tar.gz", "has_sig": false, "md5_digest": "dec11bbe73f9e5dc9a86f850482d30e3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 7795, "upload_time": "2014-09-21T18:26:21", "url": "https://files.pythonhosted.org/packages/f0/52/a44c322431dc351860990ea3a82be009b38e0b283fd156578a777f303ded/sphinxcontrib-getthecode-0.1dev-20140921.tar.gz" } ], "1.0.0": [ { "comment_text": "", "digests": { "md5": "81e406233b30640a96db25bfe34777ac", "sha256": "5f3922753b95bf93a1bee924284417b16f68079be4fd2152bb11defaa88baccf" }, "downloads": -1, "filename": "sphinxcontrib_getthecode-1.0.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "81e406233b30640a96db25bfe34777ac", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7951, "upload_time": "2017-11-26T21:16:50", "url": "https://files.pythonhosted.org/packages/07/ad/9289319a4ccee5478a6eb829c30f75e0b35a3c131f616ff24f843e008a9c/sphinxcontrib_getthecode-1.0.0-py2.py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "81e406233b30640a96db25bfe34777ac", "sha256": "5f3922753b95bf93a1bee924284417b16f68079be4fd2152bb11defaa88baccf" }, "downloads": -1, "filename": "sphinxcontrib_getthecode-1.0.0-py2.py3-none-any.whl", "has_sig": true, "md5_digest": "81e406233b30640a96db25bfe34777ac", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 7951, "upload_time": "2017-11-26T21:16:50", "url": "https://files.pythonhosted.org/packages/07/ad/9289319a4ccee5478a6eb829c30f75e0b35a3c131f616ff24f843e008a9c/sphinxcontrib_getthecode-1.0.0-py2.py3-none-any.whl" } ] }