{ "info": { "author": "Adam Dangoor", "author_email": "adamdangoor@gmail.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Web Environment", "License :: OSI Approved :: Apache Software License", "Operating System :: POSIX", "Programming Language :: Python :: 3.5" ], "description": "|Build Status| |codecov| |requirements| |PyPI|\n\nSphinx Substitution Extensions\n==============================\n\nExtensions for Sphinx which allow substitutions.\n\n.. contents::\n\nInstallation\n------------\n\n.. code:: console\n\n $ pip install Sphinx-Substitution-Extensions\n\nThis supports Python 3.5+.\n\nSetup\n~~~~~\n\n* Add the following to ``conf.py``:\n\n.. code:: python\n\n extensions += ['sphinx-prompt', 'sphinx_substitution_extensions']\n\n* Set the following variable in ``conf.py``:\n\n.. code:: python\n\n substitutions = [\n ('|release|', '0.1'),\n ('|author|', 'Eleanor'),\n ]\n\nThis will replace ``|release|`` in the new directives with ``0.1``, and ``|author|`` with ``Eleanor``.\n\nDirectives\n----------\n\n``substitution-code-block``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: rst\n\n .. substitution-code-block:: bash\n\n echo \"|author| released version |release|\"\n\nThis is an extension of Sphinx's built-in `code-block`_ directive, and adds replacement functionality.\n\n``substitution-prompt``\n~~~~~~~~~~~~~~~~~~~~~~~\n\n.. code:: rst\n\n .. substitution-prompt:: bash\n\n echo \"|author| released version |release|\"\n\nThis is an extension of `sphinx-prompt`_.\n\n``substitution-prompt`` acts similarly to `sphinx-prompt`_, and adds replacement functionality.\n\nCredits\n-------\n\n``sphinx-prompt`` authors\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThanks to `@sbrunner`_ and other contributors for `sphinx-prompt`_.\n``substitution-prompt`` is based on `sphinx-prompt`_.\n\nClusterHQ Developers\n~~~~~~~~~~~~~~~~~~~~\n\nThis package is largely inspired by code written for Flocker by ClusterHQ.\nDevelopers of the relevant code include, at least, Jon Giddy and Tom Prince.\n\nContributing\n------------\n\nSee `CONTRIBUTING.rst <./CONTRIBUTING.rst>`_.\n\n.. |Build Status| image:: https://travis-ci.com/adamtheturtle/sphinx-substitution-extensions.svg?branch=master\n :target: https://travis-ci.com/adamtheturtle/sphinx-substitution-extensions\n.. _sphinx-prompt: https://github.com/sbrunner/sphinx-prompt\n.. _code-block: http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block\n.. _@sbrunner: https://github.com/sbrunner\n.. |codecov| image:: https://codecov.io/gh/adamtheturtle/sphinx-substitution-extensions/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/adamtheturtle/sphinx-substitution-extensions\n.. |requirements| image:: https://requires.io/github/adamtheturtle/sphinx-substitution-extensions/requirements.svg?branch=master\n :target: https://requires.io/github/adamtheturtle/sphinx-substitution-extensions/requirements/?branch=master\n :alt: Requirements Status\n.. |PyPI| image:: https://badge.fury.io/py/Sphinx-Substitution-Extensions.svg\n :target: https://badge.fury.io/py/Sphinx-Substitution-Extensions\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/adamtheturtle/sphinx-substitution-extensions", "keywords": "sphinx rst documentation", "license": "Apache License, Version 2.0", "maintainer": "", "maintainer_email": "", "name": "Sphinx-Substitution-Extensions", "package_url": "https://pypi.org/project/Sphinx-Substitution-Extensions/", "platform": "", "project_url": "https://pypi.org/project/Sphinx-Substitution-Extensions/", "project_urls": { "Homepage": "https://github.com/adamtheturtle/sphinx-substitution-extensions" }, "release_url": "https://pypi.org/project/Sphinx-Substitution-Extensions/2019.6.15.0/", "requires_dist": [ "sphinx-prompt (==1.1.0)", "sphinx (==2.1.1)", "autoflake (==1.3) ; extra == 'dev'", "check-manifest (==0.39) ; extra == 'dev'", "doc8 (==0.8.0) ; extra == 'dev'", "dulwich (==0.19.11) ; extra == 'dev'", "flake8-commas (==2.0.0) ; extra == 'dev'", "flake8-quotes (==2.0.1) ; extra == 'dev'", "flake8 (==3.7.7) ; extra == 'dev'", "isort (==4.3.20) ; extra == 'dev'", "mypy (==0.701) ; extra == 'dev'", "mypy-mypyc (==0.670) ; extra == 'dev'", "pip-check-reqs (==2.0.3) ; extra == 'dev'", "pydocstyle (==3.0.0) ; extra == 'dev'", "pyenchant (==2.0.0) ; extra == 'dev'", "pygithub (==1.43.7) ; extra == 'dev'", "pylint (==2.3.1) ; extra == 'dev'", "pyroma (==2.5) ; extra == 'dev'", "pytest-cov (==2.7.1) ; extra == 'dev'", "pytest (==4.6.3) ; extra == 'dev'", "twine (==1.13.0) ; extra == 'dev'", "vulture (==1.0) ; extra == 'dev'", "yapf (==0.27.0) ; extra == 'dev'" ], "requires_python": "", "summary": "Extensions for Sphinx which allow for substitutions.", "version": "2019.6.15.0" }, "last_serial": 5403804, "releases": { "2018.11.12.1": [ { "comment_text": "", "digests": { "md5": "e4afd1f840c56baec7de929cf251fdbc", "sha256": "3a0822ecb9f9c900bda2fd462eb87c46cf1d7bd9fa5c453adb56039323b0b912" }, "downloads": -1, "filename": "Sphinx_Substitution_Extensions-2018.11.12.1-py3-none-any.whl", "has_sig": false, "md5_digest": "e4afd1f840c56baec7de929cf251fdbc", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4754, "upload_time": "2018-11-12T02:11:16", "url": "https://files.pythonhosted.org/packages/79/06/1ed2ef5fa64cd04d6b154fca58f7921349ce660579c1d170e73c028793b1/Sphinx_Substitution_Extensions-2018.11.12.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ad8f7cc5ba0f85edca9e816216780ffc", "sha256": "005d27f8d79b3e1b87d95bcc0effa0296c5ebe2748412fcd83ef7031b65d745c" }, "downloads": -1, "filename": "Sphinx Substitution Extensions-2018.11.12.1.tar.gz", "has_sig": false, "md5_digest": "ad8f7cc5ba0f85edca9e816216780ffc", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19979, "upload_time": "2018-11-12T02:11:18", "url": "https://files.pythonhosted.org/packages/5d/07/ec7c52ec15910c06f4e6918210ac21ae490137c888e7acb1750cd0d17f42/Sphinx%20Substitution%20Extensions-2018.11.12.1.tar.gz" } ], "2018.11.12.2": [ { "comment_text": "", "digests": { "md5": "0c16e194444225334c1d9d4c5f1d30f2", "sha256": "4b67e941b10c59eee5bbbea569bec9dfd83d6276380e557e6319b86e13121d10" }, "downloads": -1, "filename": "Sphinx_Substitution_Extensions-2018.11.12.2-py3-none-any.whl", "has_sig": false, "md5_digest": "0c16e194444225334c1d9d4c5f1d30f2", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7980, "upload_time": "2018-11-12T13:33:01", "url": "https://files.pythonhosted.org/packages/d7/66/646d09158ef152f4f4c7b3512feab51d3e862481d0ceb902fb75543cc77e/Sphinx_Substitution_Extensions-2018.11.12.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "18c61c883108628beda036f7acd28b23", "sha256": "6f521665828dfea716d6c367784c801bb025b618a75d8ddbd604af7877885671" }, "downloads": -1, "filename": "Sphinx Substitution Extensions-2018.11.12.2.tar.gz", "has_sig": false, "md5_digest": "18c61c883108628beda036f7acd28b23", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20287, "upload_time": "2018-11-12T13:33:02", "url": "https://files.pythonhosted.org/packages/46/42/08e819b365898b9bb9c8f1746d6270314e04d4926dc3278bdf00da5f6b3e/Sphinx%20Substitution%20Extensions-2018.11.12.2.tar.gz" } ], "2018.11.12.3": [ { "comment_text": "", "digests": { "md5": "dcee8d1b8d4471d19fe37045d5ae1df7", "sha256": "8b4197e34e162b9212076f380efbc0e6764a20f57f0390c27bb439bc405ab24e" }, "downloads": -1, "filename": "Sphinx_Substitution_Extensions-2018.11.12.3-py3-none-any.whl", "has_sig": false, "md5_digest": "dcee8d1b8d4471d19fe37045d5ae1df7", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7978, "upload_time": "2018-11-12T13:50:06", "url": "https://files.pythonhosted.org/packages/1f/74/8372670fbe912561767615f153cd2afce158480c96c8ced6f3334d1a693e/Sphinx_Substitution_Extensions-2018.11.12.3-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c2350cf941d002acad5d897a29e2c5c7", "sha256": "218db1c7b521567a6ddf240fb4d68d8b8e4c2fe0a32b60d8707a1a436c43913b" }, "downloads": -1, "filename": "Sphinx Substitution Extensions-2018.11.12.3.tar.gz", "has_sig": false, "md5_digest": "c2350cf941d002acad5d897a29e2c5c7", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20285, "upload_time": "2018-11-12T13:50:08", "url": "https://files.pythonhosted.org/packages/1c/70/074b11e672c9aaec743ae33ae69aa329d475b44e19235d86ef1cde2ac82a/Sphinx%20Substitution%20Extensions-2018.11.12.3.tar.gz" } ], "2019.4.4.1": [ { "comment_text": "", "digests": { "md5": "96d54922407d34a4b1d87837001d806d", "sha256": "095da5f158dabc1c8565d6b7115aa269b1e5aee47c6ed232b9332e66bfd677a3" }, "downloads": -1, "filename": "Sphinx_Substitution_Extensions-2019.4.4.1-py3-none-any.whl", "has_sig": false, "md5_digest": "96d54922407d34a4b1d87837001d806d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 7966, "upload_time": "2019-04-04T13:19:08", "url": "https://files.pythonhosted.org/packages/d4/46/cfb13e7817b4e005d95275aa9d301797b9f0b2d16967b9d4a5a8a4b689a8/Sphinx_Substitution_Extensions-2019.4.4.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "61ec464dddca79aae73a948beb019b29", "sha256": "ef2191135674951799c79d347906bb69697d8de75c0a12bae158ef6b6c3b30cb" }, "downloads": -1, "filename": "Sphinx Substitution Extensions-2019.4.4.1.tar.gz", "has_sig": false, "md5_digest": "61ec464dddca79aae73a948beb019b29", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20293, "upload_time": "2019-04-04T13:19:10", "url": "https://files.pythonhosted.org/packages/2c/4f/270f786cc19586641b2b276935a7d53fcbcfa2873be78896d5da5e24313d/Sphinx%20Substitution%20Extensions-2019.4.4.1.tar.gz" } ], "2019.6.15.0": [ { "comment_text": "", "digests": { "md5": "d2c454760c6a7672007d21d254b66a02", "sha256": "910f92d73f5d6981ff20a38c60dbb2d248f84d61592fa61657701a38aaae4796" }, "downloads": -1, "filename": "Sphinx_Substitution_Extensions-2019.6.15.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d2c454760c6a7672007d21d254b66a02", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8009, "upload_time": "2019-06-15T11:44:42", "url": "https://files.pythonhosted.org/packages/9a/1d/ecc8c408fdfbe8369836b8e6618f4be46243a2ab0671da074bb872b6145e/Sphinx_Substitution_Extensions-2019.6.15.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "05e118498cba88416209a106ca990212", "sha256": "ab07b78b68a4c4bca94e0a97f893a8b1f29ea85b9250629131f7cfc8c532b932" }, "downloads": -1, "filename": "Sphinx Substitution Extensions-2019.6.15.0.tar.gz", "has_sig": false, "md5_digest": "05e118498cba88416209a106ca990212", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20327, "upload_time": "2019-06-15T11:44:44", "url": "https://files.pythonhosted.org/packages/c7/a3/32624f47833b99457c945d2cd203f0389da30710aeb23046283f974b62d5/Sphinx%20Substitution%20Extensions-2019.6.15.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "d2c454760c6a7672007d21d254b66a02", "sha256": "910f92d73f5d6981ff20a38c60dbb2d248f84d61592fa61657701a38aaae4796" }, "downloads": -1, "filename": "Sphinx_Substitution_Extensions-2019.6.15.0-py3-none-any.whl", "has_sig": false, "md5_digest": "d2c454760c6a7672007d21d254b66a02", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8009, "upload_time": "2019-06-15T11:44:42", "url": "https://files.pythonhosted.org/packages/9a/1d/ecc8c408fdfbe8369836b8e6618f4be46243a2ab0671da074bb872b6145e/Sphinx_Substitution_Extensions-2019.6.15.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "05e118498cba88416209a106ca990212", "sha256": "ab07b78b68a4c4bca94e0a97f893a8b1f29ea85b9250629131f7cfc8c532b932" }, "downloads": -1, "filename": "Sphinx Substitution Extensions-2019.6.15.0.tar.gz", "has_sig": false, "md5_digest": "05e118498cba88416209a106ca990212", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 20327, "upload_time": "2019-06-15T11:44:44", "url": "https://files.pythonhosted.org/packages/c7/a3/32624f47833b99457c945d2cd203f0389da30710aeb23046283f974b62d5/Sphinx%20Substitution%20Extensions-2019.6.15.0.tar.gz" } ] }