erabo/spiegel_podman
1
0
Fork 0
mirror of https://github.com/podman-container-tools/podman.git synced 2026-09-21 15:17:59 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4
spiegel_podman/docs
History
Daniel J Walsh 3d0fa726c1
Cleanup man pages for pull and push 
The podman pull man page has a section on source, but does not show
this in the top definitions.  This PR attempts to cleanup the man page
to make it more understandable.

Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2020-04-25 06:33:06 -04:00
..
source Cleanup man pages for pull and push 2020-04-25 06:33:06 -04:00
tutorials Add image signing with GPG tutorial 2020-03-23 11:46:29 +01:00
varlink make lint: include docs/ 2020-01-14 09:54:48 +01:00
dckrman.sh Fix docker man page links 2020-03-19 14:03:02 -04:00
generate.go V2 Move varlink home 2020-03-30 08:18:35 -07:00
links-to-html.lua Update XML to not embed quote in PATH on windows 2020-01-31 15:22:20 -07:00
make.bat Restructure documentation dir 2019-10-31 12:31:39 -05:00
Makefile Restructure documentation dir 2019-10-31 12:31:39 -05:00
play.png Initial checkin from CRI-O repo 2017-11-01 11:24:59 -04:00
podman-derivative-api systemd: expect full path /usr/sbin/init 2019-10-09 23:38:45 +02:00
Readme.md Add links to readthedocs on docs/readme 2019-11-04 18:22:41 -05:00
remote-docs.sh Update document formatting and packaging code 2019-10-31 12:31:39 -05:00
requirements.txt Restructure documentation dir 2019-10-31 12:31:39 -05:00

Readme.md

Podman Documentation

The online man pages and other documents regarding Podman can be found at Read The Docs. The man pages can be found under the Commands link on that page.

Build the Docs

Directory Structure

Directory
Markdown source for man pages docs/source/markdown/
man pages aliases as .so files docs/source/markdown/links/
restructured text for readthedocs.io docs/rst/
target for output docs/build
man pages docs/build/man
remote linux man pages docs/build/remote/linux
remote darwin man pages docs/build/remote/darwin
remote windows html pages docs/build/remote/windows

Support files
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