{"library":"sphinx-markdown-tables","title":"Sphinx Markdown Tables","type":"library","description":"sphinx-markdown-tables is a Sphinx extension designed to render tables written in GitHub Flavored Markdown (GFM) within Sphinx documentation projects. It enables users to utilize familiar Markdown table syntax for documentation generated by Sphinx. The current version is 0.0.17. While not on a strict release cadence, it receives updates for bug fixes and compatibility with new Sphinx versions.","language":"python","status":"active","last_verified":"Thu Apr 16","install":{"commands":["pip install sphinx-markdown-tables"],"cli":null},"imports":[],"auth":{"required":false,"env_vars":[]},"links":{"homepage":null,"github":"https://github.com/ryanfox/sphinx-markdown-tables","docs":null,"changelog":null,"pypi":"https://pypi.org/project/sphinx-markdown-tables/","npm":null,"openapi_spec":null,"status_page":null,"smithery":null},"quickstart":{"code":"# conf.py\n# Minimal Sphinx configuration for sphinx-markdown-tables\n# Make sure you have 'myst_parser' installed if using .md files.\n# pip install myst-parser\n\nproject = 'My Markdown Tables Project'\ncopyright = '2024, Example Author'\nextensions = [\n    'myst_parser', # Required for Sphinx to parse .md files\n    'sphinx_markdown_tables' # The extension itself\n]\n# You would also set source_suffix appropriately, e.g.,\nsource_suffix = {\n    '.rst': 'restructuredtext',\n    '.md': 'markdown',\n}\nhtml_theme = 'alabaster' # Or any other Sphinx theme\n\n# Example index.md content for using markdown tables:\n# ```markdown\n# # My Document\n# \n# Here is a table:\n# \n# | Header 1 | Header 2 | Header 3 |\n# |----------|----------|----------|\n# | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |\n# | Row 2 Col 1 | Row 2 Col 2 | Row 2 Col 3 |\n# ```","lang":"python","description":"To use `sphinx-markdown-tables`, add it to the `extensions` list in your Sphinx `conf.py`. This example also includes `myst_parser`, which is commonly used to enable Sphinx to parse Markdown files (`.md`). After configuration, you can use GitHub Flavored Markdown (GFM) table syntax in your Markdown source files, and Sphinx will render them as HTML tables.","tag":null,"tag_description":null,"last_tested":null,"results":[]},"compatibility":null}