{ "info": { "author": "Sven Strack", "author_email": "sven@so36.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Environment :: Console", "Environment :: Web Environment", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Documentation", "Topic :: Utilities" ], "description": ".. -*- restructuredtext -*-\n\n.. image:: https://readthedocs.org/projects/sphinxcontrib-osexample/badge/?version=stable\n :target: http://sphinxcontrib-osexample.readthedocs.org/en/latest/?badge=stable\n :alt: Documentation Status\n\n\n==============================\nosexample extension for Sphinx\n==============================\n\nThis is a modified fork of Serge Domkowski's `examplecode extension `_ for Sphinx.\n\nAbout\n=====\n\nThis is a simple extension that, when rendered as HTML, will fold multiple\ncode blocks containing different operating systems administration examples into a single block\nwhich can be toggled from one to another using buttons.\n\nIt's intended to be used for displaying package manager examples.\n(e.g., apt install or dnf install).\n\nThis extension adds the ``example-code`` directive which adds a class to\na container wrapping the code blocks that should be folded. The class allows\nthe included Javascript and CSS to render the folded block and buttons.\n\nCurrently supported are: Debian, Ubuntu, Fedora, CentOS, OSX\n\nQuick Example\n-------------\n\nSource would look something like this::\n\n .. example-code::\n .. code-block:: Debian\n\n sudo apt install htop\n\n .. code-block:: Fedora\n\n sudo dnf install htop\n\n\nThis will create an output like this:\n\n.. image:: https://raw.githubusercontent.com/svx/sphinxcontrib-osexample/master/docs/_static/example.gif\n :alt: Example how it looks like as generated HTML\n\n\nInstallation\n------------\n\n.. code-block:: bash\n\n $ pip install sphinxcontrib-osexample\n\n\nEnabling the extension in Sphinx\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nJust add sphinxcontrib.examplecode to the list of extensions in the conf.py file. For example:\n\n.. code-block:: bash\n\n extensions = ['sphinxcontrib.osexample']\n\n\n\nDocumentation\n-------------\n\nFull documentation for end users can be found in the \"docs\" folder.\n\nIt is also available online on `Read The Docs `_\n\nContribute\n----------\n\n- `Issue Tracker `_\n- `Source Code `_\n\nSupport\n-------\n\nIf you are having issues, please let us know.\n\n\nLicense\n-------\n\nThe project is licensed under BSD.", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-osexample", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/svx/sphinxcontrib-osexample", "keywords": "Sphinx extension", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "sphinxcontrib-osexample", "package_url": "https://pypi.org/project/sphinxcontrib-osexample/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-osexample/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-osexample", "Homepage": "https://github.com/svx/sphinxcontrib-osexample" }, "release_url": "https://pypi.org/project/sphinxcontrib-osexample/0.1.1/", "requires_dist": null, "requires_python": "", "summary": "Sphinx extension for OS code-blocks", "version": "0.1.1" }, "last_serial": 1931771, "releases": { "0.1.0": [], "0.1.1": [ { "comment_text": "", "digests": { "md5": "7eefa1b3dc3a4a91aea515d4335ab988", "sha256": "ab05432cb818def8566662cf4d4815d9f18bdf2bd1da386fb3b079fb59857cb9" }, "downloads": -1, "filename": "sphinxcontrib-osexample-0.1.1.tar.gz", "has_sig": false, "md5_digest": "7eefa1b3dc3a4a91aea515d4335ab988", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4828, "upload_time": "2016-01-15T11:57:05", "url": "https://files.pythonhosted.org/packages/4d/06/2625bad796cf45065002b4144e7cef292e6d2ff45a5045b8b826798b2841/sphinxcontrib-osexample-0.1.1.tar.gz" } ], "0.1.1.dev0": [ { "comment_text": "", "digests": { "md5": "e14c601758164fcc00a7d04d1c632da4", "sha256": "0493c1dbb3506e4aac4b574f08a337fffd73f2c0163b4bacbf752a5adb0945bf" }, "downloads": -1, "filename": "sphinxcontrib-osexample-0.1.1.dev0.zip", "has_sig": false, "md5_digest": "e14c601758164fcc00a7d04d1c632da4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8520, "upload_time": "2016-01-04T11:05:37", "url": "https://files.pythonhosted.org/packages/e3/96/c3fb578092cff16e25f326d4559fd07c37e2710a8ad509de62c03ae7cf24/sphinxcontrib-osexample-0.1.1.dev0.zip" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "7eefa1b3dc3a4a91aea515d4335ab988", "sha256": "ab05432cb818def8566662cf4d4815d9f18bdf2bd1da386fb3b079fb59857cb9" }, "downloads": -1, "filename": "sphinxcontrib-osexample-0.1.1.tar.gz", "has_sig": false, "md5_digest": "7eefa1b3dc3a4a91aea515d4335ab988", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4828, "upload_time": "2016-01-15T11:57:05", "url": "https://files.pythonhosted.org/packages/4d/06/2625bad796cf45065002b4144e7cef292e6d2ff45a5045b8b826798b2841/sphinxcontrib-osexample-0.1.1.tar.gz" } ] }