| Name | sphinx-datatables JSON |
| Version |
0.2.1
JSON |
| download |
| home_page | |
| Summary | Searchable and sortable tables in Sphinx documentation |
| upload_time | 2024-02-18 19:17:45 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2023 Varun Sharma Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
sphinx
table
datatables
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
..
Copyright (c) 2023 Varun Sharma
SPDX-License-Identifier: MIT
Sphinx DataTables
=================
This extension makes it easy to use more expressive tables in Sphinx documentation with `DataTables <https://datatables.net/>`__.
See the demo and full documentation `online <https://sharm294.github.io/sphinx-datatables/>`__.
Installation
------------
.. code-block:: console
pip install sphinx-datatables
Usage
-----
Add the extension in your ``conf.py``:
.. code-block:: python
extensions = [
"sphinxcontrib.jquery",
"sphinx_datatables",
]
In your ``.rst`` documentation, create a table and add a custom class label.
Your table must have a valid header row.
.. code-block:: rst
.. csv-table::
:header: First Name,Last Name
:class: sphinx-datatable
John,Smith
Jane,Doe
Configuration
-------------
The following configuration options are available with the following default values:
.. code-block:: python
# in conf.py
# set the version to use for DataTables plugin
datatables_version = "1.13.4"
# name of the class to use for tables to enable DataTables
datatables_class = "sphinx-datatable"
# any custom options to pass to the DataTables constructor. Note that any
# options you set are used for all DataTables.
datatables_options = {}
Raw data
{
"_id": null,
"home_page": "",
"name": "sphinx-datatables",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "sphinx,table,datatables",
"author": "",
"author_email": "Varun Sharma <29899983+sharm294@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/1f/d7/5e156865e12d8a4b8fe1c2eb6b201998914000aacc68a4a8a8884e365000/sphinx-datatables-0.2.1.tar.gz",
"platform": null,
"description": "..\n Copyright (c) 2023 Varun Sharma\n\n SPDX-License-Identifier: MIT\n\nSphinx DataTables\n=================\n\nThis extension makes it easy to use more expressive tables in Sphinx documentation with `DataTables <https://datatables.net/>`__.\nSee the demo and full documentation `online <https://sharm294.github.io/sphinx-datatables/>`__.\n\nInstallation\n------------\n\n.. code-block:: console\n\n pip install sphinx-datatables\n\nUsage\n-----\n\nAdd the extension in your ``conf.py``:\n\n.. code-block:: python\n\n extensions = [\n \"sphinxcontrib.jquery\",\n \"sphinx_datatables\",\n ]\n\nIn your ``.rst`` documentation, create a table and add a custom class label.\nYour table must have a valid header row.\n\n.. code-block:: rst\n\n .. csv-table::\n :header: First Name,Last Name\n :class: sphinx-datatable\n\n John,Smith\n Jane,Doe\n\nConfiguration\n-------------\n\nThe following configuration options are available with the following default values:\n\n.. code-block:: python\n\n # in conf.py\n\n # set the version to use for DataTables plugin\n datatables_version = \"1.13.4\"\n\n # name of the class to use for tables to enable DataTables\n datatables_class = \"sphinx-datatable\"\n\n # any custom options to pass to the DataTables constructor. Note that any\n # options you set are used for all DataTables.\n datatables_options = {}\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2023 Varun Sharma Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Searchable and sortable tables in Sphinx documentation",
"version": "0.2.1",
"project_urls": {
"Documentation": "https://sharm294.github.io/sphinx-datatables/",
"Home": "https://github.com/sharm294/sphinx-datatables"
},
"split_keywords": [
"sphinx",
"table",
"datatables"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ed1cab092695982b81a0b0d118d4ef0ddc9c58fce7c5c2a0ee50855383af145e",
"md5": "7be350323e1d35d7581d4d51edcc6bb9",
"sha256": "9d4381307710c4609e494a1de300a434d70368e0223454fcf1c8d9523de8fa70"
},
"downloads": -1,
"filename": "sphinx_datatables-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7be350323e1d35d7581d4d51edcc6bb9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 5387,
"upload_time": "2024-02-18T19:17:42",
"upload_time_iso_8601": "2024-02-18T19:17:42.094169Z",
"url": "https://files.pythonhosted.org/packages/ed/1c/ab092695982b81a0b0d118d4ef0ddc9c58fce7c5c2a0ee50855383af145e/sphinx_datatables-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1fd75e156865e12d8a4b8fe1c2eb6b201998914000aacc68a4a8a8884e365000",
"md5": "21a7372dd87b0990c7709ddffa38c3b5",
"sha256": "3d727237a16f4dbed1164419da6e8ab15bb9eb459217613b079f9f4de3b350d3"
},
"downloads": -1,
"filename": "sphinx-datatables-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "21a7372dd87b0990c7709ddffa38c3b5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 4237,
"upload_time": "2024-02-18T19:17:45",
"upload_time_iso_8601": "2024-02-18T19:17:45.470085Z",
"url": "https://files.pythonhosted.org/packages/1f/d7/5e156865e12d8a4b8fe1c2eb6b201998914000aacc68a4a8a8884e365000/sphinx-datatables-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-18 19:17:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sharm294",
"github_project": "sphinx-datatables",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "sphinx-datatables"
}
