diff options
| author | OpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com> | 2021-03-31 11:11:47 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-31 11:11:47 +0200 |
| commit | dbb7009e5586d41a5b64806ae5fb664dc77c7bdb (patch) | |
| tree | f0e089312f65e27790c6218bcbae068501f0be58 | |
| parent | a373e2fdf38456b8ac584809e73cdb9f9521a796 (diff) | |
| parent | 09f2c01ded216c9d7fa6b976f2af98bde474e99a (diff) | |
| download | podman-dbb7009e5586d41a5b64806ae5fb664dc77c7bdb.tar.gz podman-dbb7009e5586d41a5b64806ae5fb664dc77c7bdb.tar.bz2 podman-dbb7009e5586d41a5b64806ae5fb664dc77c7bdb.zip | |
Merge pull request #9877 from TomSweeneyRedHat/dev/tsweeney/docreadme
[CI:DOCS] Add local html build info to docs/README.md
| -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 +``` |