Skip to content

Commit

Permalink
Merge pull request containers#9877 from TomSweeneyRedHat/dev/tsweeney…
Browse files Browse the repository at this point in the history
…/docreadme

[CI:DOCS] Add local html build info to docs/README.md
  • Loading branch information
openshift-merge-robot authored Mar 31, 2021
2 parents a373e2f + 09f2c01 commit dbb7009
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/Readme.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

0 comments on commit dbb7009

Please sign in to comment.