summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2019-11-08 01:25:14 +0100
committerGitHub <noreply@github.com>2019-11-08 01:25:14 +0100
commit3463a7194c504790e73a1750109c1813a7c3cfe9 (patch)
tree3ec2dcc27bb2bfa0ead66207987b3691777f2ed4
parent3ec9ee090e18e79c20e6f76274ce582b656be91c (diff)
parentc2a4e0105c9a69354e0fb2edf9c5f9403ea4d5c3 (diff)
downloadpodman-3463a7194c504790e73a1750109c1813a7c3cfe9.tar.gz
podman-3463a7194c504790e73a1750109c1813a7c3cfe9.tar.bz2
podman-3463a7194c504790e73a1750109c1813a7c3cfe9.zip
Merge pull request #4444 from TomSweeneyRedHat/dev/tsweeney/readthedocs
Add links to readthedocs on docs/readme
-rw-r--r--docs/Readme.md9
1 files changed, 8 insertions, 1 deletions
diff --git a/docs/Readme.md b/docs/Readme.md
index 4514afa77..209dcd6b4 100644
--- a/docs/Readme.md
+++ b/docs/Readme.md
@@ -1,3 +1,10 @@
+# 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
+can be found under the [Commands](https://podman.readthedocs.io/en/latest/Commands.html)
+link on that page.
+
# Build the Docs
## Directory Structure
@@ -18,4 +25,4 @@
| | |
| ------------------------------------ | --------------------------- |
| 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 | \ No newline at end of file
+| docs/links-to-html.lua | pandoc filter to do aliases for html files |