container/podman
container/podman
1
0
Fork 0
mirror of https://github.com/containers/podman synced 2024-10-19 16:54:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add links to readthedocs on docs/readme

Browse source 
Add a couple of links to the new ReadTheDocs site
for the libpod man pages from the docs/readme.md.  Many users
go to github.com/{project}/docs looking for the man pages for
the project and their location is not evident on the current
readme.md.

Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
This commit is contained in:
TomSweeneyRedHat 2019-11-04 18:22:32 -05:00
parent 17eadda68b
commit c2a4e0105c
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
docs/Readme.md
View file

@ -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 |
| docs/links-to-html.lua | pandoc filter to do aliases for html files |