erabo/spiegel_podman
1
0
Fork 0
mirror of https://github.com/podman-container-tools/podman.git synced 2026-09-02 21:57:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
spiegel_podman/docs
History
TomSweeneyRedHat c2a4e0105c Add links to readthedocs on docs/readme 
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>
2019-11-04 18:22:41 -05:00
..
source [docs] Ensure we include section 5 documentation 2019-11-02 13:48:47 +01:00
tutorials Markdown Formatting Fixes 2019-10-18 15:38:30 -06:00
varlink document nullable types 2019-05-22 10:08:03 -05:00
dckrman.sh Add support for mimicing docker CLI 2018-01-18 07:01:48 -05:00
generate.go Rename varlink socket and interface 2018-08-06 14:49:11 +00:00
links-to-html.lua Support podman-remote help on windows 2019-09-19 14:14:38 -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