diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/conf.py | 26 | ||||
| -rw-r--r-- | docs/source/markdown/podman-machine-start.1.md | 3 |
2 files changed, 29 insertions, 0 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 883e1240e..52869baf4 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -14,6 +14,8 @@ # import sys # sys.path.insert(0, os.path.abspath('.')) +import re +from recommonmark.transform import AutoStructify # -- Project information ----------------------------------------------------- @@ -59,3 +61,27 @@ html_css_files = [ ] # -- Extension configuration ------------------------------------------------- + +def convert_markdown_title(app, docname, source): + # Process markdown files only + docpath = app.env.doc2path(docname) + if docpath.endswith(".md"): + # Convert pandoc title line into eval_rst block for recommonmark + source[0] = re.sub( + r"^% (.*)", + r"```eval_rst\n.. title:: \g<1>\n```", + source[0]) + + +def setup(app): + app.connect("source-read", convert_markdown_title) + + app.add_config_value( + "recommonmark_config", { + "enable_eval_rst": True, + "enable_auto_doc_ref": False, + "enable_auto_toc_tree": False, + "enable_math": False, + "enable_inline_math": False, + }, True) + app.add_transform(AutoStructify) diff --git a/docs/source/markdown/podman-machine-start.1.md b/docs/source/markdown/podman-machine-start.1.md index 22942767a..b430f51eb 100644 --- a/docs/source/markdown/podman-machine-start.1.md +++ b/docs/source/markdown/podman-machine-start.1.md @@ -14,6 +14,9 @@ Podman on MacOS requires a virtual machine. This is because containers are Linux containers do not run on any other OS because containers' core functionality are tied to the Linux kernel. +Only one Podman managed VM can be active at a time. If a VM is already running, +`podman machine start` will return an error. + **podman machine start** starts a Linux virtual machine where containers are run. ## OPTIONS |