diff options
| author | Paul Holzinger <paul.holzinger@web.de> | 2020-11-13 13:48:49 +0100 |
|---|---|---|
| committer | Paul Holzinger <paul.holzinger@web.de> | 2020-11-13 16:42:13 +0100 |
| commit | 80b613d2376dec453e041a4afd5570d710f93b28 (patch) | |
| tree | 942c3be675a901da625a24acd4ced7f4f5a3e378 | |
| parent | 0b1a60ec27928a40ac827148c1517098612616bd (diff) | |
| download | podman-80b613d2376dec453e041a4afd5570d710f93b28.tar.gz podman-80b613d2376dec453e041a4afd5570d710f93b28.tar.bz2 podman-80b613d2376dec453e041a4afd5570d710f93b28.zip | |
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 <paul.holzinger@web.de>
| -rw-r--r-- | docs/requirements.txt | 2 | ||||
| -rw-r--r-- | docs/source/conf.py | 7 |
2 files changed, 8 insertions, 1 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt index 44af373ac..84e7ec6a5 100644 --- 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 index aad458a9b..368d7cc29 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -28,9 +28,14 @@ author = "team" # 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"] |