{ "info": { "author": "D. Lawrence", "author_email": "trea@treamous.com", "bugtrack_url": null, "classifiers": [ "Framework :: Sphinx", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Topic :: Documentation", "Topic :: Software Development :: Documentation" ], "description": "# sphinx-variations\n\nA Sphinx extension that allows project maintainers to create multiple variations of their documentation, based on its usage of the `.. only` directive. Each variation contains a Sphinx tag and a friendly name.\n\n## How to Use\n\n### Installing\nsphinx-variations is available on PyPi:\n\n```\npython3 -m pip install sphinx-variations\n```\n\nAfter installing the package, list the extension in your Sphinx project's `conf.py`.\n\n```\nextensions = [..., 'variations']\n```\n\n### Configuration\n\nTo create multiple variations for your docs, a list of tags to use as variations can be inserted into your `conf.py` file:\n\n```\nvariations = [( [tagname], [friendly name] )]\n```\n\nFor example:\n\n```\nvariations = [('python', 'Python'),\n ('cpp', 'C++')]\n```\n\nThe above will cause two copies of the documentation text to be made, each in a directory with the tag name. Static files are not copied between the two variations, but are shared between them.\n\n### Template Variables\nThis extension also provides two template variables, `variations` and `currentvariation`.\n\n`variations` contains the complete list of variations in the same format specified above, and `currentvariation` contains the tuple for the current variation.\n\nThese variables can be used to create links between the different variations of your documentation, for example.\n\n# License\nMIT, see `LICENSE`.\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/treamology/sphinx-variations", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "sphinx-variations", "package_url": "https://pypi.org/project/sphinx-variations/", "platform": "", "project_url": "https://pypi.org/project/sphinx-variations/", "project_urls": { "Homepage": "https://github.com/treamology/sphinx-variations" }, "release_url": "https://pypi.org/project/sphinx-variations/1.0.2/", "requires_dist": [ "sphinx" ], "requires_python": "", "summary": "Create multiple variations of your Sphinx HTML documentation.", "version": "1.0.2" }, "last_serial": 5299797, "releases": { "1.0": [ { "comment_text": "", "digests": { "md5": "01668a4203b433aa17932589d16e555b", "sha256": "19e68a091768d7e6a1bab0a8a2f1f830d7db6169cad51ec2548af7422e3622be" }, "downloads": -1, "filename": "sphinx_variations-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "01668a4203b433aa17932589d16e555b", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4420, "upload_time": "2019-05-21T18:39:52", "url": "https://files.pythonhosted.org/packages/2e/25/e932ede7e7e12fb03120b165dedf514fee358855e8270e645bb8bc53f3d1/sphinx_variations-1.0-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "601a562b8cf4973beaa343341f436aa4", "sha256": "445f77793aea6bf4181e09da61b238d7dd2bd1d2c9d74f9e56458cb7fd67114f" }, "downloads": -1, "filename": "sphinx-variations-1.0.tar.gz", "has_sig": false, "md5_digest": "601a562b8cf4973beaa343341f436aa4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3332, "upload_time": "2019-05-21T18:39:54", "url": "https://files.pythonhosted.org/packages/f2/1f/71415f3dfdc298c2342b87dae1a60fcc985c76df48ddaa71c88291e64760/sphinx-variations-1.0.tar.gz" } ], "1.0.1": [ { "comment_text": "", "digests": { "md5": "2b2dc75591d205104af165c848b10482", "sha256": "0d2ddc8951919238248266f2d31dcc698413df8415c6e14749d8d6b9b21b4367" }, "downloads": -1, "filename": "sphinx_variations-1.0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "2b2dc75591d205104af165c848b10482", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4505, "upload_time": "2019-05-21T20:37:00", "url": "https://files.pythonhosted.org/packages/ca/ca/a1dc2d26ba9794f2d1c62ace779651f9160163263a8aec44a7628f8eebe0/sphinx_variations-1.0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "c88df52dbb0545c9fdc26c1e85967606", "sha256": "ea5ff87f4f64d3786151383453026de0d44a6c657804207667d830add616ab1e" }, "downloads": -1, "filename": "sphinx-variations-1.0.1.tar.gz", "has_sig": false, "md5_digest": "c88df52dbb0545c9fdc26c1e85967606", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3399, "upload_time": "2019-05-21T20:37:01", "url": "https://files.pythonhosted.org/packages/2a/1c/86d9aab55ae4c66a75d22e9ef53b09b566a2fff718029954336034132fb3/sphinx-variations-1.0.1.tar.gz" } ], "1.0.2": [ { "comment_text": "", "digests": { "md5": "5050f4061a028fa1da819e668c4a492c", "sha256": "373e801ffd7d418fb95d9304d9e4962ec0ae27776a7316aa9b0b66be4cbd5e05" }, "downloads": -1, "filename": "sphinx_variations-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5050f4061a028fa1da819e668c4a492c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4662, "upload_time": "2019-05-21T21:08:37", "url": "https://files.pythonhosted.org/packages/3f/a3/ad9f51c73afdca65b62266d1b7ce52e059ec2c0faddcc924c7f488184285/sphinx_variations-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fee76a17ffda8d2efb39d5adcc3dafd8", "sha256": "c29ff3374751198f48aa76f1d30bda4183057c0c6376b4b831d47e919e633f45" }, "downloads": -1, "filename": "sphinx-variations-1.0.2.tar.gz", "has_sig": false, "md5_digest": "fee76a17ffda8d2efb39d5adcc3dafd8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3554, "upload_time": "2019-05-21T21:08:38", "url": "https://files.pythonhosted.org/packages/16/57/ff3e5aa31b27dabce83b59f8ff9f7cb0cf179517760c3e61b0287a45d16b/sphinx-variations-1.0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "5050f4061a028fa1da819e668c4a492c", "sha256": "373e801ffd7d418fb95d9304d9e4962ec0ae27776a7316aa9b0b66be4cbd5e05" }, "downloads": -1, "filename": "sphinx_variations-1.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "5050f4061a028fa1da819e668c4a492c", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4662, "upload_time": "2019-05-21T21:08:37", "url": "https://files.pythonhosted.org/packages/3f/a3/ad9f51c73afdca65b62266d1b7ce52e059ec2c0faddcc924c7f488184285/sphinx_variations-1.0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "fee76a17ffda8d2efb39d5adcc3dafd8", "sha256": "c29ff3374751198f48aa76f1d30bda4183057c0c6376b4b831d47e919e633f45" }, "downloads": -1, "filename": "sphinx-variations-1.0.2.tar.gz", "has_sig": false, "md5_digest": "fee76a17ffda8d2efb39d5adcc3dafd8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3554, "upload_time": "2019-05-21T21:08:38", "url": "https://files.pythonhosted.org/packages/16/57/ff3e5aa31b27dabce83b59f8ff9f7cb0cf179517760c3e61b0287a45d16b/sphinx-variations-1.0.2.tar.gz" } ] }