[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 containers#9856 for the man pages to preview any changes that are made. Signed-off-by: TomSweeneyRedHat <[email protected]>
rhatdan · Mar 30, 2021 · 09f2c01 · 09f2c01
1 parent a373e2f
commit 09f2c01
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/Readme.md → docs/README.md b/docs/Readme.md → 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
+```