summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorTomSweeneyRedHat <tsweeney@redhat.com>2021-03-29 17:52:15 -0400
committerTomSweeneyRedHat <tsweeney@redhat.com>2021-03-30 18:45:40 -0400
commit09f2c01ded216c9d7fa6b976f2af98bde474e99a (patch)
treef0e089312f65e27790c6218bcbae068501f0be58 /docs
parenta373e2fdf38456b8ac584809e73cdb9f9521a796 (diff)
downloadpodman-09f2c01ded216c9d7fa6b976f2af98bde474e99a.tar.gz
podman-09f2c01ded216c9d7fa6b976f2af98bde474e99a.tar.bz2
podman-09f2c01ded216c9d7fa6b976f2af98bde474e99a.zip
[CI:DOCS] Add local html build info to docs/README.md
Rename Readme.md to README.md in the docs directory. Add the local build process per @Luap99 in #9856 for the man pages to preview any changes that are made. Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md (renamed from docs/Readme.md)16
1 files changed, 16 insertions, 0 deletions
diff --git a/docs/Readme.md b/docs/README.md
index e0918cd54..83f5c79a3 100644
--- a/docs/Readme.md
+++ b/docs/README.md
@@ -52,3 +52,19 @@ likely caused by broken metadata needed to protect clients from cross-site-scrip
style attacks. Please [notify a maintainer](https://github.com/containers/podman#communications)
so they may investigate how/why the `swagger.yaml` file's CORS-metadata is
incorrect, or the file isn't accessible for some other reason.
+
+## Local Testing
+
+Assuming that you have the [dependencies](https://podman.io/getting-started/installation#build-and-run-dependencies)
+installed, then also install (showing Fedora in the example):
+
+```
+# dnf install python3-sphinx python3-recommonmark
+# pip install sphinx-markdown-tables
+```
+After that completes, cd to the `docs` directory in your Podman sandbox and then do `make html`.
+
+You can then preview the html files in `docs/build/html` with:
+```
+python -m http.server 8000 --directory build/html
+```