containers
/
podman
mirror of https://github.com/containers/podman.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9877 from TomSweeneyRedHat/dev/tsweeney/docreadme 

[CI:DOCS] Add local html build info to docs/README.md
This commit is contained in:
OpenShift Merge Robot 2021-03-31 11:11:47 +02:00 committed by GitHub
parent a373e2fdf3 09f2c01ded
commit dbb7009e55
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/Readme.md → docs/README.md
View File

@ -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
```