# sphinx-markdown-tables
A [Sphinx](http://www.sphinx-doc.org/en/master/) extension for rendering markdown tables.
Sphinx supports markdown via [Recommonmark,](https://github.com/rtfd/recommonmark) which does not support tables. This
extension provides them.
It renders markdown tables as HTML, as defined by [python-markdown](https://python-markdown.github.io/)
## Installation
pip install sphinx-markdown-tables
## Usage
### Quick version
Add `sphinx_markdown_tables` to `extensions` in `conf.py`, like so:
extensions = [
'sphinx_markdown_tables',
]
### Longer version
Sphinx needs to be configured to use markdown. First, you need `recommonmark`:
pip install recommonmark
In `conf.py`, configure `source_parsers` and `source_suffix`:
source_parsers = {
'.md': 'recommonmark.parser.CommonMarkParser',
}
source_suffix = ['.rst', '.md']
Once Sphinx is configured appropriately, add `sphinx_markdown_tables` to `extensions`, like so:
extensions = [
'sphinx_markdown_tables',
]
For more information on Sphinx and markdown, see the
[Sphinx documentation.](http://www.sphinx-doc.org/en/master/usage/markdown.html)
## License
This project is available under the GPLv3 license. For other licensing arrangements contact
[Ryan Fox.](https://foxrow.com)
Raw data
{
"_id": null,
"home_page": "https://github.com/ryanfox/sphinx-markdown-tables",
"name": "sphinx-markdown-tables",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sphinx markdown tables",
"author": "Ryan Fox",
"author_email": "ryan@foxrow.com",
"download_url": "https://files.pythonhosted.org/packages/fb/36/af0e0a4aa69298b4d664d5176243412ae96bfc207d7e3314e12b3a6f2ccc/sphinx-markdown-tables-0.0.17.tar.gz",
"platform": null,
"description": "# sphinx-markdown-tables\n\nA [Sphinx](http://www.sphinx-doc.org/en/master/) extension for rendering markdown tables.\n\nSphinx supports markdown via [Recommonmark,](https://github.com/rtfd/recommonmark) which does not support tables. This\nextension provides them.\n\nIt renders markdown tables as HTML, as defined by [python-markdown](https://python-markdown.github.io/)\n\n## Installation\n\n pip install sphinx-markdown-tables\n\n## Usage\n\n### Quick version\nAdd `sphinx_markdown_tables` to `extensions` in `conf.py`, like so:\n\n extensions = [\n 'sphinx_markdown_tables',\n ]\n\n### Longer version\nSphinx needs to be configured to use markdown. First, you need `recommonmark`:\n\n pip install recommonmark\n\nIn `conf.py`, configure `source_parsers` and `source_suffix`:\n\n source_parsers = {\n '.md': 'recommonmark.parser.CommonMarkParser',\n }\n\n source_suffix = ['.rst', '.md']\n\nOnce Sphinx is configured appropriately, add `sphinx_markdown_tables` to `extensions`, like so:\n\n extensions = [\n 'sphinx_markdown_tables',\n ]\n\nFor more information on Sphinx and markdown, see the\n[Sphinx documentation.](http://www.sphinx-doc.org/en/master/usage/markdown.html)\n\n## License\nThis project is available under the GPLv3 license. For other licensing arrangements contact\n[Ryan Fox.](https://foxrow.com)\n",
"bugtrack_url": null,
"license": "",
"summary": "A Sphinx extension for rendering tables written in markdown",
"version": "0.0.17",
"project_urls": {
"Bug Reports": "https://github.com/ryanfox/sphinx-markdown-tables/issues",
"Homepage": "https://github.com/ryanfox/sphinx-markdown-tables",
"Say Thanks!": "https://foxrow.com",
"Source": "https://github.com/ryanfox/sphinx-markdown-tables/"
},
"split_keywords": [
"sphinx",
"markdown",
"tables"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "938d8785a36892992582ef8d87c69ab90e26124ab1059c501d93ebecd99d2323",
"md5": "04c5c2ae72e9979b7c462e0e77b248a9",
"sha256": "2bd0c30779653e4dd120300cbd9ca412c480738cc2241f6dea477a883f299e04"
},
"downloads": -1,
"filename": "sphinx_markdown_tables-0.0.17-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04c5c2ae72e9979b7c462e0e77b248a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 28018,
"upload_time": "2022-07-29T00:35:44",
"upload_time_iso_8601": "2022-07-29T00:35:44.956911Z",
"url": "https://files.pythonhosted.org/packages/93/8d/8785a36892992582ef8d87c69ab90e26124ab1059c501d93ebecd99d2323/sphinx_markdown_tables-0.0.17-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb36af0e0a4aa69298b4d664d5176243412ae96bfc207d7e3314e12b3a6f2ccc",
"md5": "7240d3da2a215a462b849f66187b4ee7",
"sha256": "6bc6d3d400eaccfeebd288446bc08dd83083367c58b85d40fe6c12d77ef592f1"
},
"downloads": -1,
"filename": "sphinx-markdown-tables-0.0.17.tar.gz",
"has_sig": false,
"md5_digest": "7240d3da2a215a462b849f66187b4ee7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15189,
"upload_time": "2022-07-29T00:35:46",
"upload_time_iso_8601": "2022-07-29T00:35:46.641678Z",
"url": "https://files.pythonhosted.org/packages/fb/36/af0e0a4aa69298b4d664d5176243412ae96bfc207d7e3314e12b3a6f2ccc/sphinx-markdown-tables-0.0.17.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-07-29 00:35:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ryanfox",
"github_project": "sphinx-markdown-tables",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sphinx-markdown-tables"
}
JSON
