aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authoropenshift-ci[bot] <75433959+openshift-ci[bot]@users.noreply.github.com>2022-08-04 11:56:07 +0000
committerGitHub <noreply@github.com>2022-08-04 11:56:07 +0000
commit4dff697b772bc3a99e6b1e9755f48c2a6194348c (patch)
tree3f69eda56e9edc6ca2115a09cbce5059b087eac0
parentccbb8e7444423306691f8ec441ed09387718d6e5 (diff)
parent79b10a7c6a2ee5981b563d8ba733a6a8e44d01cb (diff)
downloadpodman-4dff697b772bc3a99e6b1e9755f48c2a6194348c.tar.gz
podman-4dff697b772bc3a99e6b1e9755f48c2a6194348c.tar.bz2
podman-4dff697b772bc3a99e6b1e9755f48c2a6194348c.zip
Merge pull request #15191 from Luap99/docs-2
fix sphinx build to include podman-create/run page
-rw-r--r--docs/source/conf.py13
-rwxr-xr-xhack/markdown-preprocess5
2 files changed, 17 insertions, 1 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 505bcbec7..b58bb3f46 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -15,6 +15,19 @@
# sys.path.insert(0, os.path.abspath('.'))
import re
+import os
+import subprocess
+
+# We have to run the preprocessor to create the actual markdown files from .in files.
+# Do it here so the it can work on readthedocs as well.
+path = os.path.join(os.path.abspath(os.path.dirname(
+ __file__)), "../../hack/markdown-preprocess")
+p = subprocess.Popen(path,
+ stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+out, err = p.communicate()
+if p.returncode != 0:
+ raise Exception("failed to run markdown-preprocess", out, err)
+
# -- Project information -----------------------------------------------------
diff --git a/hack/markdown-preprocess b/hack/markdown-preprocess
index 578615845..6d2675cc4 100755
--- a/hack/markdown-preprocess
+++ b/hack/markdown-preprocess
@@ -8,8 +8,11 @@ import os
import sys
def main():
+ script_dir = os.path.abspath(os.path.dirname(__file__))
+ man_dir = os.path.join(script_dir,"../docs/source/markdown")
+
try:
- os.chdir("docs/source/markdown")
+ os.chdir(man_dir)
except FileNotFoundError:
raise Exception("Please invoke me from the base repo dir")