From 5072f4307c3c5521a14c221be7b4358b8e5c07a7 Mon Sep 17 00:00:00 2001 From: Oleg Broytman Date: Sun, 16 Apr 2017 01:41:39 +0300 Subject: [PATCH] Initial docs --- README.txt | 3 ++- docs/Makefile | 6 +++--- docs/index.rst | 21 +++++++++++++++++++++ 3 files changed, 26 insertions(+), 4 deletions(-) diff --git a/README.txt b/README.txt index 0bb241d..a2c8961 100644 --- a/README.txt +++ b/README.txt @@ -2,4 +2,5 @@ Broytman remove-old-files, Copyright (C) 2017 PhiloSoft Design Author: Oleg Broytman License: GPL -Remove old files. +Remove old files. It's a portable replacement for +`find start_dir -type f -mtime +31 -delete`. diff --git a/docs/Makefile b/docs/Makefile index 10de652..3b8c804 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -12,9 +12,9 @@ BUILDDIR = _build help: @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -.PHONY: help Makefile +.PHONY: help # 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) \ No newline at end of file +%: Makefile conf.py + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/index.rst b/docs/index.rst index 17c64cb..1fa4162 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -6,11 +6,32 @@ Welcome to remove-old-files's documentation! ============================================ +Remove old files. It's a portable replacement for +`find start_dir -type f -mtime +31 -delete`. + .. toctree:: :maxdepth: 2 :caption: Contents: + news + +.. highlight:: none + +Command line +------------ + +remove-old-files.py +~~~~~~~~~~~~~~~~~~~ + +Usage:: + + remove-old-files.py -o days start_dir + +Options:: + -o days, --older days + remove files older than this number of days; + this is a required option Indices and tables ================== -- 2.39.5