Fix markdown tables on docs.podman.io

Sphinx with recommonmark cannot render markdown tables at all. There is a python package called `sphinx-markdown-tables` which adds the markdown table support to recommonmark. https://pypi.org/project/sphinx-markdown-tables/ By utilising this package we don't have to change our doc format. Signed-off-by: Paul Holzinger <[email protected]>
rhatdan · Nov 13, 2020 · 80b613d · 80b613d
1 parent 0b1a60e
commit 80b613d
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,3 +2,5 @@
 
 # use md instead of rst
 recommonmark
+# needed for markdown table support
+sphinx-markdown-tables
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -28,9 +28,14 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    "recommonmark",
+    'sphinx_markdown_tables',
 ]
 
+source_parsers = {
+    '.md': 'recommonmark.parser.CommonMarkParser',
+}
+
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]