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/Makefile | 123 ------------------------------- docs/rtd/make.bat | 35 --------- docs/rtd/requirements.txt | 4 - docs/rtd/source/Commands.rst | 107 --------------------------- docs/rtd/source/Introduction.rst | 2 - docs/rtd/source/Reference.rst | 2 - docs/rtd/source/Tutorials.rst | 2 - docs/rtd/source/conf.py | 57 -------------- docs/rtd/source/index.rst | 26 ------- 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 --- 18 files changed, 534 deletions(-) delete mode 100644 docs/rtd/Makefile delete mode 100644 docs/rtd/make.bat delete mode 100644 docs/rtd/requirements.txt delete mode 100644 docs/rtd/source/Commands.rst delete mode 100644 docs/rtd/source/Introduction.rst delete mode 100644 docs/rtd/source/Reference.rst delete mode 100644 docs/rtd/source/Tutorials.rst delete mode 100644 docs/rtd/source/conf.py delete mode 100644 docs/rtd/source/index.rst 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') diff --git a/docs/rtd/Makefile b/docs/rtd/Makefile deleted file mode 100644 index 50af6490a..000000000 --- a/docs/rtd/Makefile +++ /dev/null @@ -1,123 +0,0 @@ -# Minimal makefile for Sphinx documentation -# - -# You can set these variables from the command line, and also -# from the environment for the first two. -SPHINXOPTS ?= -SPHINXBUILD ?= sphinx-build -SOURCEDIR = source -BUILDDIR = build - -# Put it first so that "make" without argument is like "make help". -help: - @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -clean: - rm -fr build/ - rm -f source/man/podman-*.1.md - -copy: - cp -v ../podman-attach.1.md source/man/ - cp -v ../podman-build.1.md source/man/ - cp -v ../podman-commit.1.md source/man/ - # container - cp -v ../podman-container-checkpoint.1.md source/man/ - cp -v ../podman-container-exists.1.md source/man/ - cp -v ../podman-container-restore.1.md source/man/ - cp -v ../podman-container-cleanup.1.md source/man/ - cp -v ../podman-container-prune.1.md source/man/ - cp -v ../podman-container-runlabel.1.md source/man/ - cp -v ../podman-cp.1.md source/man/ - cp -v ../podman-create.1.md source/man/ - cp -v ../podman-diff.1.md source/man/ - cp -v ../podman-events.1.md source/man/ - cp -v ../podman-exec.1.md source/man/ - cp -v ../podman-export.1.md source/man/ - # generate - cp -v ../podman-generate-systemd.1.md source/man/ - cp -v ../podman-generate-kube.1.md source/man/ - # healthcheck - cp -v ../podman-healthcheck-run.1.md source/man/ - #cp -v ../podman-help.1.md source/ - cp -v ../podman-history.1.md source/man/ - # image - cp -v ../podman-image-prune.1.md source/man/ - cp -v ../podman-image-tree.1.md source/man/ - cp -v ../podman-image-trust.1.md source/man/ - cp -v ../podman-image-exists.1.md source/man/ - cp -v ../podman-image-sign.1.md source/man/ - cp -v ../podman-images.1.md source/man/ - cp -v ../podman-import.1.md source/man/ - cp -v ../podman-info.1.md source/man/ - cp -v ../podman-init.1.md source/man/ - cp -v ../podman-inspect.1.md source/man/ - cp -v ../podman-kill.1.md source/man/ - cp -v ../podman-load.1.md source/man/ - cp -v ../podman-login.1.md source/man/ - cp -v ../podman-logout.1.md source/man/ - cp -v ../podman-logs.1.md source/man/ - cp -v ../podman-mount.1.md source/man/ - # network - cp -v ../podman-network-create.1.md source/man/ - cp -v ../podman-network-ls.1.md source/man/ - cp -v ../podman-network-inspect.1.md source/man/ - cp -v ../podman-network-rm.1.md source/man/ - cp -v ../podman-pause.1.md source/man/ - # play - cp -v ../podman-play-kube.1.md source/man/ - # pod - cp -v ../podman-pod-create.1.md source/man/ - cp -v ../podman-pod-pause.1.md source/man/ - cp -v ../podman-pod-rm.1.md source/man/ - cp -v ../podman-pod-top.1.md source/man/ - cp -v ../podman-pod-exists.1.md source/man/ - cp -v ../podman-pod-prune.1.md source/man/ - cp -v ../podman-pod-start.1.md source/man/ - cp -v ../podman-pod-unpause.1.md source/man/ - cp -v ../podman-pod-inspect.1.md source/man/ - cp -v ../podman-pod-ps.1.md source/man/ - cp -v ../podman-pod-stats.1.md source/man/ - cp -v ../podman-pod-kill.1.md source/man/ - cp -v ../podman-pod-restart.1.md source/man/ - cp -v ../podman-pod-stop.1.md source/man/ - cp -v ../podman-port.1.md source/man/ - cp -v ../podman-ps.1.md source/man/ - cp -v ../podman-pull.1.md source/man/ - cp -v ../podman-push.1.md source/man/ - cp -v ../podman-restart.1.md source/man/ - cp -v ../podman-rm.1.md source/man/ - cp -v ../podman-rmi.1.md source/man/ - cp -v ../podman-run.1.md source/man/ - cp -v ../podman-save.1.md source/man/ - cp -v ../podman-search.1.md source/man/ - cp -v ../podman-start.1.md source/man/ - cp -v ../podman-stats.1.md source/man/ - cp -v ../podman-stop.1.md source/man/ - # system - cp -v ../podman-system-migrate.1.md source/man/ - cp -v ../podman-system-renumber.1.md source/man/ - cp -v ../podman-system-df.1.md source/man/ - cp -v ../podman-system-prune.1.md source/man/ - cp -v ../podman-top.1.md source/man/ - cp -v ../podman-umount.1.md source/man/ - cp -v ../podman-unpause.1.md source/man/ - cp -v ../podman-unshare.1.md source/man/ - cp -v ../podman-varlink.1.md source/man/ - cp -v ../podman-version.1.md source/man/ - # volume - cp -v ../podman-volume-inspect.1.md source/man/ - cp -v ../podman-volume-prune.1.md source/man/ - cp -v ../podman-volume-create.1.md source/man/ - cp -v ../podman-volume-ls.1.md source/man/ - cp -v ../podman-volume-rm.1.md source/man/ - cp -v ../podman-wait.1.md source/man/ - -.PHONY: help Makefile copy - -html: copy - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) - -# Catch-all target: route all unknown targets to Sphinx using the new -# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). -%: Makefile - @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/rtd/make.bat b/docs/rtd/make.bat deleted file mode 100644 index 6247f7e23..000000000 --- a/docs/rtd/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set SOURCEDIR=source -set BUILDDIR=build - -if "%1" == "" goto help - -%SPHINXBUILD% >NUL 2>NUL -if errorlevel 9009 ( - echo. - echo.The 'sphinx-build' command was not found. Make sure you have Sphinx - echo.installed, then set the SPHINXBUILD environment variable to point - echo.to the full path of the 'sphinx-build' executable. Alternatively you - echo.may add the Sphinx directory to PATH. - echo. - echo.If you don't have Sphinx installed, grab it from - echo.http://sphinx-doc.org/ - exit /b 1 -) - -%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% -goto end - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/docs/rtd/requirements.txt b/docs/rtd/requirements.txt deleted file mode 100644 index 44af373ac..000000000 --- a/docs/rtd/requirements.txt +++ /dev/null @@ -1,4 +0,0 @@ -# requirements file for readthedocs pip installs - -# use md instead of rst -recommonmark diff --git a/docs/rtd/source/Commands.rst b/docs/rtd/source/Commands.rst deleted file mode 100644 index f6ba5b20d..000000000 --- a/docs/rtd/source/Commands.rst +++ /dev/null @@ -1,107 +0,0 @@ -Commands -======== - - -:doc:`attach ` Attach to a running container - -:doc:`build ` Build an image using instructions from Containerfiles - -:doc:`commit ` Create new image based on the changed container - -:doc:`containers ` Manage Containers - -: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:`events ` Show podman events - -:doc:`exec ` Run a process in a running container - -:doc:`export ` Export container's filesystem contents as a tar archive - -:doc:`generate ` Generated structured data - -:doc:`healthcheck ` Manage Healthcheck - -:doc:`history ` Show history of a specified image - -:doc:`image ` Manage images - -:doc:`images ` List images in local storage - -:doc:`import ` Import a tarball to create a filesystem image - -:doc:`info ` Display podman system information - -: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:`load ` Load an image from container archive - -:doc:`login ` Login to a container registry - -:doc:`logout ` Logout of a container registry - -:doc:`logs ` Fetch the logs of a container - -:doc:`mount ` Mount a working container's root filesystem - -:doc:`network ` Manage Networks - -:doc:`pause ` Pause all the processes in one or more containers - -:doc:`play ` Play a pod - -:doc:`pod ` Manage pods - -:doc:`port ` List port mappings or a specific mapping for the container - -:doc:`ps ` List containers - -:doc:`pull ` Pull an image from a registry - -:doc:`push ` Push an image to a specified destination - -:doc:`restart ` Restart one or more containers - -:doc:`rm ` Remove one or more containers - -:doc:`rmi ` Removes one or more images from local storage - -:doc:`run ` Run a command in a new container - -:doc:`save ` Save image to an archive - -:doc:`search ` Search registry for image - -: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:`system ` Manage podman - -:doc:`tag ` Add an additional name to a local image - -: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:`unshare ` Run a command in a modified user namespace - -:doc:`varlink ` Run varlink interface - -:doc:`version ` Display the Podman Version Information - -:doc:`volume ` Manage volumes - -:doc:`wait ` Block on one or more containers \ No newline at end of file diff --git a/docs/rtd/source/Introduction.rst b/docs/rtd/source/Introduction.rst deleted file mode 100644 index c516b3317..000000000 --- a/docs/rtd/source/Introduction.rst +++ /dev/null @@ -1,2 +0,0 @@ -Introduction -============ diff --git a/docs/rtd/source/Reference.rst b/docs/rtd/source/Reference.rst deleted file mode 100644 index 9a771c87f..000000000 --- a/docs/rtd/source/Reference.rst +++ /dev/null @@ -1,2 +0,0 @@ -Reference -========= diff --git a/docs/rtd/source/Tutorials.rst b/docs/rtd/source/Tutorials.rst deleted file mode 100644 index 0c7e28c3b..000000000 --- a/docs/rtd/source/Tutorials.rst +++ /dev/null @@ -1,2 +0,0 @@ -Tutorials -========= diff --git a/docs/rtd/source/conf.py b/docs/rtd/source/conf.py deleted file mode 100644 index d95290f72..000000000 --- a/docs/rtd/source/conf.py +++ /dev/null @@ -1,57 +0,0 @@ -# Configuration file for the Sphinx documentation builder. -# -# This file only contains a selection of the most common options. For a full -# list see the documentation: -# https://www.sphinx-doc.org/en/master/usage/configuration.html - -# -- Path setup -------------------------------------------------------------- - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - - -# -- Project information ----------------------------------------------------- - -project = 'Podman' -copyright = '2019, team' -author = 'team' - - -# -- General configuration --------------------------------------------------- - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -extensions = [ - 'recommonmark', -] - -# Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This pattern also affects html_static_path and html_extra_path. -exclude_patterns = [] - -master_doc = 'index' - -# -- Options for HTML output ------------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -html_theme = 'alabaster' - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] - - -# -- Extension configuration ------------------------------------------------- diff --git a/docs/rtd/source/index.rst b/docs/rtd/source/index.rst deleted file mode 100644 index 9dd61a6a6..000000000 --- a/docs/rtd/source/index.rst +++ /dev/null @@ -1,26 +0,0 @@ -.. Podman documentation master file, created by - sphinx-quickstart on Tue Oct 22 15:20:30 2019. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Podman's documentation! -================================== - -.. toctree:: - :maxdepth: 2 - :caption: Contents: - - Introduction - Commands - Reference - Tutorials - - - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` 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