From 52b92023edeba3a5e2c466d92d742e54b14a85cb Mon Sep 17 00:00:00 2001 From: baude Date: Thu, 24 Oct 2019 14:54:57 -0500 Subject: Restructure documentation dir Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude --- docs/rtd/source/man/generate.rst | 6 --- docs/rtd/source/man/healthcheck.rst | 4 -- docs/rtd/source/man/image.rst | 35 ----------------- docs/rtd/source/man/managecontainers.rst | 64 -------------------------------- docs/rtd/source/man/network.rst | 10 ----- docs/rtd/source/man/play.rst | 4 -- docs/rtd/source/man/pod.rst | 30 --------------- docs/rtd/source/man/system.rst | 12 ------ docs/rtd/source/man/volume.rst | 11 ------ 9 files changed, 176 deletions(-) delete mode 100644 docs/rtd/source/man/generate.rst delete mode 100644 docs/rtd/source/man/healthcheck.rst delete mode 100644 docs/rtd/source/man/image.rst delete mode 100644 docs/rtd/source/man/managecontainers.rst delete mode 100644 docs/rtd/source/man/network.rst delete mode 100644 docs/rtd/source/man/play.rst delete mode 100644 docs/rtd/source/man/pod.rst delete mode 100644 docs/rtd/source/man/system.rst delete mode 100644 docs/rtd/source/man/volume.rst (limited to 'docs/rtd/source/man') diff --git a/docs/rtd/source/man/generate.rst b/docs/rtd/source/man/generate.rst deleted file mode 100644 index e82a15735..000000000 --- a/docs/rtd/source/man/generate.rst +++ /dev/null @@ -1,6 +0,0 @@ -Generate -======== - -:doc:`kube ` Generate Kubernetes pod YAML from a container or pod - -:doc:`systemd ` Generate a systemd unit file for a Podman container diff --git a/docs/rtd/source/man/healthcheck.rst b/docs/rtd/source/man/healthcheck.rst deleted file mode 100644 index 697c1358b..000000000 --- a/docs/rtd/source/man/healthcheck.rst +++ /dev/null @@ -1,4 +0,0 @@ -HealthCheck -=========== - -:doc:`run ` run the health check of a container diff --git a/docs/rtd/source/man/image.rst b/docs/rtd/source/man/image.rst deleted file mode 100644 index ad963cd41..000000000 --- a/docs/rtd/source/man/image.rst +++ /dev/null @@ -1,35 +0,0 @@ -Image -===== - - -:doc:`build ` Build an image using instructions from Containerfiles - -:doc:`exists ` Check if an image exists in local storage - -:doc:`history ` Show history of a specified image - -:doc:`import ` Import a tarball to create a filesystem image - -:doc:`inspect ` Display the configuration of an image - -:doc:`list ` List images in local storage - -:doc:`load ` Load an image from container archive - -:doc:`prune ` Remove unused images - -:doc:`pull ` Pull an image from a registry - -:doc:`push ` Push an image to a specified destination - -:doc:`rm ` Removes one or more images from local storage - -:doc:`save ` Save image to an archive - -:doc:`sign ` Sign an image - -:doc:`tag ` Add an additional name to a local image - -:doc:`tree ` Prints layer hierarchy of an image in a tree format - -:doc:`trust ` Manage container image trust policy diff --git a/docs/rtd/source/man/managecontainers.rst b/docs/rtd/source/man/managecontainers.rst deleted file mode 100644 index 20e8c0679..000000000 --- a/docs/rtd/source/man/managecontainers.rst +++ /dev/null @@ -1,64 +0,0 @@ -Manage Containers -================= - -:doc:`attach ` Attach to a running container - -:doc:`checkpoint ` Checkpoints one or more containers - -:doc:`cleanup ` Cleanup network and mountpoints of one or more containers - -:doc:`commit ` Create new image based on the changed container - -:doc:`cp ` Copy files/folders between a container and the local filesystem - -:doc:`create ` Create but do not start a container - -:doc:`diff ` Inspect changes on container's file systems - -:doc:`exec ` Run a process in a running container - -:doc:`exists ` Check if a container exists in local storage - -:doc:`export ` Export container's filesystem contents as a tar archive - -:doc:`init ` Initialize one or more containers - -:doc:`inspect ` Display the configuration of a container or image - -:doc:`kill ` Kill one or more running containers with a specific signal - -:doc:`list ` List containers - -:doc:`logs ` Fetch the logs of a container - -:doc:`mount ` Mount a working container's root filesystem - -:doc:`pause ` Pause all the processes in one or more containers - -:doc:`port ` List port mappings or a specific mapping for the container - -:doc:`restart ` Restart one or more containers - -:doc:`prune ` Remove all stopped containers - -:doc:`restore ` Restores one or more containers from a checkpoint - -:doc:`rm ` Remove one or more containers - -:doc:`run ` Run a command in a new container - -:doc:`runlabel ` Execute the command described by an image label - -:doc:`start ` Start one or more containers - -:doc:`stats ` Display a live stream of container resource usage statistics - -:doc:`stop ` Stop one or more containers - -:doc:`top ` Display the running processes of a container - -:doc:`umount ` Unmounts working container's root filesystem - -:doc:`unpause ` Unpause the processes in one or more containers - -:doc:`wait ` Block on one or more containers diff --git a/docs/rtd/source/man/network.rst b/docs/rtd/source/man/network.rst deleted file mode 100644 index 6d6a4c022..000000000 --- a/docs/rtd/source/man/network.rst +++ /dev/null @@ -1,10 +0,0 @@ -Network -===== - -:doc:`create ` network create - -:doc:`inspect ` network inspect - -:doc:`ls ` network list - -:doc:`rm ` network rm \ No newline at end of file diff --git a/docs/rtd/source/man/play.rst b/docs/rtd/source/man/play.rst deleted file mode 100644 index 93e1a9a1e..000000000 --- a/docs/rtd/source/man/play.rst +++ /dev/null @@ -1,4 +0,0 @@ -Play -==== - -:doc:`kube ` Play a pod based on Kubernetes YAML diff --git a/docs/rtd/source/man/pod.rst b/docs/rtd/source/man/pod.rst deleted file mode 100644 index 13c1740f8..000000000 --- a/docs/rtd/source/man/pod.rst +++ /dev/null @@ -1,30 +0,0 @@ -Pod -=== - -:doc:`create ` Create a new empty pod - -:doc:`exists ` Check if a pod exists in local storage - -:doc:`inspect ` Displays a pod configuration - -:doc:`kill ` Send the specified signal or SIGKILL to containers in pod - -:doc:`pause ` Pause one or more pods - -:doc:`prune ` Remove all stopped pods - -:doc:`ps ` List pods - -:doc:`restart ` Restart one or more pods - -:doc:`rm ` Remove one or more pods - -:doc:`start ` Start one or more pods - -:doc:`stats ` Display a live stream of resource usage statistics for the containers in one or more pods - -:doc:`stop ` Stop one or more pods - -:doc:`top ` Display the running processes of containers in a pod - -:doc:`unpause ` Unpause one or more pods diff --git a/docs/rtd/source/man/system.rst b/docs/rtd/source/man/system.rst deleted file mode 100644 index 764ec01c1..000000000 --- a/docs/rtd/source/man/system.rst +++ /dev/null @@ -1,12 +0,0 @@ -System -====== - -:doc:`df ` Show podman disk usage - -:doc:`info ` Display podman system information - -:doc:`migrate ` Migrate containers - -:doc:`prune ` Remove unused data - -:doc:`renumber ` Migrate lock numbers diff --git a/docs/rtd/source/man/volume.rst b/docs/rtd/source/man/volume.rst deleted file mode 100644 index ee18e4b2e..000000000 --- a/docs/rtd/source/man/volume.rst +++ /dev/null @@ -1,11 +0,0 @@ -Volume -====== -:doc:`create ` Create a new volume - -:doc:`inspect ` Display detailed information on one or more volumes - -:doc:`ls ` List volumes - -:doc:`prune ` Remove all unused volumes - -:doc:`rm ` Remove one or more volumes \ No newline at end of file -- cgit v1.2.3-54-g00ecf