opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #4444 from TomSweeneyRedHat/dev/tsweeney/readthedocs

Browse Source 
Add links to readthedocs on docs/readme
This commit is contained in:
OpenShift Merge Robot
2019-11-08 01:25:14 +01:00
committed by GitHub
parent 3ec9ee090e c2a4e0105c
commit 3463a7194c
1 changed files with 8 additions and 1 deletions
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 |