diff options
Diffstat (limited to 'docs/Readme.md')
| -rw-r--r-- | docs/Readme.md | 13 |
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/Readme.md b/docs/Readme.md index 209dcd6b4..987a5b8e4 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,7 +1,7 @@ # Podman Documentation The online man pages and other documents regarding Podman can be found at -[Read The Docs](https://podman.readthedocs.io/en/latest/index.html). The man pages +[Read The Docs](https://podman.readthedocs.io). The man pages can be found under the [Commands](https://podman.readthedocs.io/en/latest/Commands.html) link on that page. @@ -26,3 +26,14 @@ link on that page. | ------------------------------------ | --------------------------- | | docs/remote-docs.sh | Read the docs/source/markdown files and format for each platform | | docs/links-to-html.lua | pandoc filter to do aliases for html files | + +## API Reference + +The [latest online documentation](http://docs.podman.io/en/latest/_static/api.html) is +automatically generated from committed upstream sources. There is a short-duration +cache involved, in case old content or an error is returned, try clearing your browser +cache or returning to the site after 10-30 minutes. + +***Maintainers Note***: Please refer to [the Cirrus-CI tasks +documentation](../contrib/cirrus/README.md#docs-task) for +important operational details. |