From 09f2c01ded216c9d7fa6b976f2af98bde474e99a Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Mon, 29 Mar 2021 17:52:15 -0400 Subject: [PATCH] [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 --- docs/{Readme.md => README.md} | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) rename docs/{Readme.md => README.md} (84%) diff --git a/docs/Readme.md b/docs/README.md similarity index 84% rename from docs/Readme.md rename to docs/README.md index e0918cd548..83f5c79a3b 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 +```