{ "info": { "author": "Kirill Simonov (Prometheus Research, LLC)", "author_email": "xi@resolvent.net", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Operating System :: OS Independent", "Programming Language :: Python", "Topic :: Documentation", "Topic :: Text Processing" ], "description": "*********************************************************\n ``sphinxcontrib-htsql`` -- HTSQL extension for Sphinx\n*********************************************************\n\nOverview\n========\n\n``sphinxcontrib-htsql`` is an extension for embedding HTSQL_ queries\nin Sphinx_ documents.\n\nYou can see this extension in action at\nhttp://htsql.org/doc/overview.html#htsql-in-a-nutshell. For more\nexamples, see ``demo`` directory in the source distribution.\n\nThis software is written by Kirill Simonov (`Prometheus Research, LLC`_)\nand released under BSD license.\n\n\nUsage\n=====\n\nTo enable this extension, add the following line to ``conf.py``::\n\n extensions.append('sphinxcontrib.htsql')\n\nYou also need to specify the address of the HTSQL service::\n\n htsql_root = 'http://demo.htsql.org'\n\nNow you can add HTSQL queries to any Sphinx document using ``htsql``\ndirective::\n\n .. htsql:: /school?campus='old'\n\nThis directive executes the query and inserts a composite block\nconsisting of the query string and the query output in tabular form.\n\nIf a query spans many lines, it could be written within the directive\nbody::\n\n .. htsql::\n\n /school.define(num_dept := count(department))\n {code, num_dept}?num_dept>3\n\nIf you want to display one query with the output of another query, use\n``output`` option. It is useful for describing destructive operations,\nnot-yet-implemented features or escaping rules. You need to quote\nwhitespace and special characters manually::\n\n .. htsql:: /school?campus='north'\n :output: /school?campus='south'\n\nNormally, the ``htsql`` directive expects the query to be valid. Use\n``error`` option to indicate that the query is invalid and you want to\nshow the error message::\n\n .. htsql:: /school{code, title}\n :error:\n\nNormally, the query is rendered with a link leading to the HTSQL\nservice. Use ``no-link`` option to disable this feature::\n\n .. htsql:: /school?exists(department)\n :no-link:\n\nUse ``no-output`` option to render the query, but not the output::\n\n .. htsql:: /school[ns]\n :no-output:\n\nUse ``no-input`` option to render the query output, but not the query\nitself::\n\n .. htsql:: /school[ns]\n :no-input:\n\nNormally, query output is rendered as a table. Use option ``raw`` to\nrender the output unformatted::\n\n .. htsql:: /school[ns]/:json\n :raw:\n\nUse ``cut`` option to truncate the query output up to the given number\nof lines. This option works both with tabular and raw output::\n\n .. htsql:: /school\n :cut: 3\n\n\nReference\n=========\n\nDirectives\n----------\n\n``htsql-root``\n Specifies the address of the HTSQL service.\n \n This directive overrides the ``htsql_root`` configuration parameter\n for the rest of the current document.\n\n This directive has no body and no options.\n\n``htsql``\n Inserts output of an HTSQL query.\n\n The query could be specified as the parameter of the directive or (for\n multi-line queries) as the directive content.\n\n This directive is rendered as a composite block with two entries:\n\n * A literal block with the query string and a link to the HTSQL\n service.\n\n * A table with the query output.\n\n Options:\n\n ``output``\n A query to use as a source for the output block.\n\n ``error``\n Accept invalid queries and render the error message in the\n output block.\n\n ``no-link``\n Do not link the query block to the HTSQL service.\n\n ``no-input``\n Do not render the query block.\n\n ``no-output``\n Do not render the output block.\n\n ``raw``\n Render the output unformatted.\n\n ``cut``\n Truncate the output to the given number of lines.\n\nConfiguration parameters\n------------------------\n\n``htsql_root``\n The address of HTSQL service.\n\nCSS classes\n-----------\n\n``htsql-io``\n Wraps the output of ``htsql`` directive.\n\n``htsql-input``\n Wraps the query block.\n\n``htsql-output``\n Wraps the output block.\n\n``htsql-link``\n Wraps a link to the HTSQL service.\n\n``htsql-arrow-link``\n Wraps an arrow symbol with a link to the HTSQL service.\n\n\n.. _Sphinx: http://sphinx-doc.org/\n.. _HTSQL: http://htsql.org/\n.. _Prometheus Research, LLC: http://prometheusresearch.com/\n\n\n.. vim: set spell spelllang=en textwidth=72:", "description_content_type": null, "docs_url": null, "download_url": "http://pypi.python.org/pypi/sphinxcontrib-htsql", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://bitbucket.org/prometheus/sphinxcontrib-htsql", "keywords": null, "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "sphinxcontrib-htsql", "package_url": "https://pypi.org/project/sphinxcontrib-htsql/", "platform": "any", "project_url": "https://pypi.org/project/sphinxcontrib-htsql/", "project_urls": { "Download": "http://pypi.python.org/pypi/sphinxcontrib-htsql", "Homepage": "http://bitbucket.org/prometheus/sphinxcontrib-htsql" }, "release_url": "https://pypi.org/project/sphinxcontrib-htsql/0.1.5/", "requires_dist": null, "requires_python": null, "summary": "HTSQL extension for Sphinx", "version": "0.1.5" }, "last_serial": 1429242, "releases": { "0.1.1": [ { "comment_text": "", "digests": { "md5": "6719796a55ff0920e3e0b10b669eb637", "sha256": "b21e056a87b35d8d63603c2d1ad1049a57c86cd5555e5c9d0419000b694ac906" }, "downloads": -1, "filename": "sphinxcontrib-htsql-0.1.1.tar.gz", "has_sig": false, "md5_digest": "6719796a55ff0920e3e0b10b669eb637", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10312, "upload_time": "2013-03-01T00:46:01", "url": "https://files.pythonhosted.org/packages/d1/27/540253d877fef5c62ec75a289eb3306358c6cf600a68728abe462a16af7a/sphinxcontrib-htsql-0.1.1.tar.gz" } ], "0.1.2": [ { "comment_text": "", "digests": { "md5": "436a6fb7eae11951a83cc6d413716f8a", "sha256": "e76e72da443bc9c252521a81a20c4241110ccedae9fc9fed89cfe6fd3d9e0f10" }, "downloads": -1, "filename": "sphinxcontrib-htsql-0.1.2.tar.gz", "has_sig": false, "md5_digest": "436a6fb7eae11951a83cc6d413716f8a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 10277, "upload_time": "2013-03-21T15:26:21", "url": "https://files.pythonhosted.org/packages/2c/5c/bbab21440f63eea90a59afc7dec8d060dd7394704efd71e92ee08c14a9ae/sphinxcontrib-htsql-0.1.2.tar.gz" } ], "0.1.4": [], "0.1.5": [ { "comment_text": "", "digests": { "md5": "88df9dc3f10938d74458f2cc682f430e", "sha256": "07186650924d168e4c38939b6234e029e83d2b2dde1402f055ba4ac3852dbe68" }, "downloads": -1, "filename": "sphinxcontrib_htsql-0.1.5-py2-none-any.whl", "has_sig": false, "md5_digest": "88df9dc3f10938d74458f2cc682f430e", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 11293, "upload_time": "2015-02-18T23:51:33", "url": "https://files.pythonhosted.org/packages/8b/2b/eaff6788c215a0d3272e5e72b3bbcaaa6deef6f6e7417820249da42457d2/sphinxcontrib_htsql-0.1.5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "44ae34032caa32c1032b34fb0f0d23b5", "sha256": "a7e2e166416741ea7fe8c22e1ab320e53751e5f0b4f5ab44ed9b1a942664b3c3" }, "downloads": -1, "filename": "sphinxcontrib-htsql-0.1.5.tar.gz", "has_sig": false, "md5_digest": "44ae34032caa32c1032b34fb0f0d23b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11828, "upload_time": "2015-02-18T23:51:31", "url": "https://files.pythonhosted.org/packages/33/d6/1c72ffc646c028df4f95cc32dc0226a709cc2b1bdd8cee97455eb3bebf8b/sphinxcontrib-htsql-0.1.5.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "88df9dc3f10938d74458f2cc682f430e", "sha256": "07186650924d168e4c38939b6234e029e83d2b2dde1402f055ba4ac3852dbe68" }, "downloads": -1, "filename": "sphinxcontrib_htsql-0.1.5-py2-none-any.whl", "has_sig": false, "md5_digest": "88df9dc3f10938d74458f2cc682f430e", "packagetype": "bdist_wheel", "python_version": "2.7", "requires_python": null, "size": 11293, "upload_time": "2015-02-18T23:51:33", "url": "https://files.pythonhosted.org/packages/8b/2b/eaff6788c215a0d3272e5e72b3bbcaaa6deef6f6e7417820249da42457d2/sphinxcontrib_htsql-0.1.5-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "44ae34032caa32c1032b34fb0f0d23b5", "sha256": "a7e2e166416741ea7fe8c22e1ab320e53751e5f0b4f5ab44ed9b1a942664b3c3" }, "downloads": -1, "filename": "sphinxcontrib-htsql-0.1.5.tar.gz", "has_sig": false, "md5_digest": "44ae34032caa32c1032b34fb0f0d23b5", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11828, "upload_time": "2015-02-18T23:51:31", "url": "https://files.pythonhosted.org/packages/33/d6/1c72ffc646c028df4f95cc32dc0226a709cc2b1bdd8cee97455eb3bebf8b/sphinxcontrib-htsql-0.1.5.tar.gz" } ] }