From 613ef220f39a38779abc61c5f23d65f6d1a91efd Mon Sep 17 00:00:00 2001 From: Daniel J Walsh Date: Thu, 16 Sep 2021 12:29:35 -0400 Subject: Fix up build the docs site [NO TESTS NEEDED] Signed-off-by: Daniel J Walsh --- docs/source/Commands.rst | 24 +++++++------- docs/source/connection.rst | 12 ------- docs/source/generate.rst | 6 ---- docs/source/healthcheck.rst | 4 --- docs/source/image.rst | 47 --------------------------- docs/source/machine.rst | 15 --------- docs/source/managecontainers.rst | 68 ---------------------------------------- docs/source/manifest.rst | 18 ----------- docs/source/network.rst | 20 ------------ docs/source/play.rst | 4 --- docs/source/pod.rst | 32 ------------------- docs/source/secret.rst | 9 ------ docs/source/system.rst | 18 ----------- 13 files changed, 12 insertions(+), 265 deletions(-) delete mode 100644 docs/source/connection.rst delete mode 100644 docs/source/generate.rst delete mode 100644 docs/source/healthcheck.rst delete mode 100644 docs/source/image.rst delete mode 100644 docs/source/machine.rst delete mode 100644 docs/source/managecontainers.rst delete mode 100644 docs/source/manifest.rst delete mode 100644 docs/source/network.rst delete mode 100644 docs/source/play.rst delete mode 100644 docs/source/pod.rst delete mode 100644 docs/source/secret.rst delete mode 100644 docs/source/system.rst (limited to 'docs') diff --git a/docs/source/Commands.rst b/docs/source/Commands.rst index 767b09c08..2911efe18 100644 --- a/docs/source/Commands.rst +++ b/docs/source/Commands.rst @@ -13,7 +13,7 @@ Commands :doc:`commit ` Create new image based on the changed container -:doc:`container ` Manage Containers +:doc:`container ` Manage Containers :doc:`cp ` Copy files/folders between a container and the local filesystem @@ -27,13 +27,13 @@ Commands :doc:`export ` Export container's filesystem contents as a tar archive -:doc:`generate ` Generated structured data +:doc:`generate ` Generated structured data -:doc:`healthcheck ` Manage Healthcheck +:doc:`healthcheck ` Manage Healthcheck :doc:`history ` Show history of a specified image -:doc:`image ` Manage images +:doc:`image ` Manage images :doc:`images ` List images in local storage @@ -55,19 +55,19 @@ Commands :doc:`logs ` Fetch the logs of a container -:doc:`machine ` Manage podman's virtual machine +:doc:`machine ` Manage podman's virtual machine -:doc:`manifest ` Create and manipulate manifest lists and image indexes +:doc:`manifest ` Create and manipulate manifest lists and image indexes :doc:`mount ` Mount a working container's root filesystem -:doc:`network ` Manage Networks +:doc:`network ` Manage Networks :doc:`pause ` Pause all the processes in one or more containers -:doc:`play ` Play a pod +:doc:`play ` Play a pod -:doc:`pod ` Manage pods +:doc:`pod ` Manage pods :doc:`port ` List port mappings or a specific mapping for the container @@ -91,7 +91,7 @@ Commands :doc:`search ` Search registry for image -:doc:`secret ` Manage podman secrets +:doc:`secret ` Manage podman secrets :doc:`start ` Start one or more containers @@ -99,7 +99,7 @@ Commands :doc:`stop ` Stop one or more containers -:doc:`system ` Manage podman +:doc:`system ` Manage podman :doc:`tag ` Add an additional name to a local image @@ -115,6 +115,6 @@ Commands :doc:`version ` Display the Podman Version Information -:doc:`volume ` Manage volumes +:doc:`volume ` Manage volumes :doc:`wait ` Block on one or more containers diff --git a/docs/source/connection.rst b/docs/source/connection.rst deleted file mode 100644 index 64eb18c57..000000000 --- a/docs/source/connection.rst +++ /dev/null @@ -1,12 +0,0 @@ -Manage the destination(s) for Podman service(s) -================= - -:doc:`add ` Record destination for the Podman service - -:doc:`default ` Set named destination as default for the Podman service - -:doc:`list ` List the destination for the Podman service(s) - -:doc:`remove ` Delete named destination - -:doc:`rename ` Rename the destination for Podman service diff --git a/docs/source/generate.rst b/docs/source/generate.rst deleted file mode 100644 index fd267ce62..000000000 --- a/docs/source/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/source/healthcheck.rst b/docs/source/healthcheck.rst deleted file mode 100644 index 2e2f88fbc..000000000 --- a/docs/source/healthcheck.rst +++ /dev/null @@ -1,4 +0,0 @@ -HealthCheck -=========== - -:doc:`run ` run the health check of a container diff --git a/docs/source/image.rst b/docs/source/image.rst deleted file mode 100644 index 0987a0149..000000000 --- a/docs/source/image.rst +++ /dev/null @@ -1,47 +0,0 @@ -Image -===== - - -:doc:`build ` Build an image using instructions from Containerfiles - -:doc:`diff ` Inspect changes on an image's filesystem - -: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:`mount ` Mount an image's root filesystem. - -: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:`scp ` Securely copy an image from one host to another - -:doc:`search ` Search a registry for an image - -: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 - -:doc:`unmount ` Unmount an image's root filesystem - -:doc:`untag ` Removes one or more names from a locally-stored image diff --git a/docs/source/machine.rst b/docs/source/machine.rst deleted file mode 100644 index 3962fca99..000000000 --- a/docs/source/machine.rst +++ /dev/null @@ -1,15 +0,0 @@ -Machine -====== - - -:doc:`init ` Initialize a new virtual machine - -:doc:`list ` List virtual machines - -:doc:`rm ` Remove a virtual machine - -:doc:`ssh ` SSH into a virtual machine - -:doc:`start ` Start a virtual machine - -:doc:`stop ` Stop a virtual machine diff --git a/docs/source/managecontainers.rst b/docs/source/managecontainers.rst deleted file mode 100644 index 9b3978f25..000000000 --- a/docs/source/managecontainers.rst +++ /dev/null @@ -1,68 +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:`prune ` Remove all stopped containers - -:doc:`ps ` List containers - -:doc:`rename ` Rename an existing container - -:doc:`restart ` Restart one or more 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:`unmount ` 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/source/manifest.rst b/docs/source/manifest.rst deleted file mode 100644 index f0a06c2c7..000000000 --- a/docs/source/manifest.rst +++ /dev/null @@ -1,18 +0,0 @@ -Create and manipulate manifest lists and image indexes -================= - -:doc:`add ` Add an image to a manifest list or image index - -:doc:`annotate ` Add or update information about an entry in a manifest list or image index - -:doc:`create ` Create a manifest list or image index - -:doc:`exists ` Check if the given manifest list exists in local storage - -:doc:`inspect ` Display a manifest list or image index - -:doc:`push ` Push a manifest list or image index to a registry - -:doc:`remove ` Remove an image from a manifest list or image index - -:doc:`rm ` Remove manifest list or image index from local storage diff --git a/docs/source/network.rst b/docs/source/network.rst deleted file mode 100644 index eb0c2c7f9..000000000 --- a/docs/source/network.rst +++ /dev/null @@ -1,20 +0,0 @@ -Network -======= - -:doc:`connect ` network connect - -:doc:`create ` network create - -:doc:`disconnect ` network disconnect - -:doc:`exists ` network exists - -:doc:`inspect ` network inspect - -:doc:`ls ` network list - -:doc:`prune ` network prune - -:doc:`reload ` network reload - -:doc:`rm ` network rm diff --git a/docs/source/play.rst b/docs/source/play.rst deleted file mode 100644 index 8f00d2f45..000000000 --- a/docs/source/play.rst +++ /dev/null @@ -1,4 +0,0 @@ -Play -==== - -:doc:`kube ` Play a pod based on Kubernetes YAML diff --git a/docs/source/pod.rst b/docs/source/pod.rst deleted file mode 100644 index d9ad07d83..000000000 --- a/docs/source/pod.rst +++ /dev/null @@ -1,32 +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:`logs ` Displays logs for pod with one or more containers - -:doc:`pause ` Pause one or more pods - -:doc:`prune ` Remove all stopped pods and their containers - -:doc:`ps ` List pods - -:doc:`restart ` Restart one or more pods - -:doc:`rm ` Remove one or more stopped pods and containers - -: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/source/secret.rst b/docs/source/secret.rst deleted file mode 100644 index 3825ad1df..000000000 --- a/docs/source/secret.rst +++ /dev/null @@ -1,9 +0,0 @@ -Secret -====== -:doc:`create ` Create a new secert - -:doc:`inspect ` Display detailed information on one or more secrets - -:doc:`ls ` List secrets - -:doc:`rm ` Remove one or more secrets diff --git a/docs/source/system.rst b/docs/source/system.rst deleted file mode 100644 index 566fd1a95..000000000 --- a/docs/source/system.rst +++ /dev/null @@ -1,18 +0,0 @@ -System -====== - -:doc:`connection ` Manage the destination(s) for Podman service(s) - -: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 - -:doc:`reset ` Reset podman storage - -:doc:`service ` Run an API service -- cgit v1.2.3-54-g00ecf