Initial docs

diff --git a/README.txt b/README.txt
index 0bb241db135a37d550bdd67b3a31103e9e3db18b..a2c89611e6078dbb7afab1e0085fee00d0e0cdfb 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -2,4 +2,5 @@ Broytman remove-old-files, Copyright (C) 2017 PhiloSoft Design
 Author: Oleg Broytman <phd@phdru.name>
 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 10de652e884255c84182fb82378c4b6cc9a614b1..3b8c8046c941a837674035582a89ff3c32705add 100644 (file)
--- 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 17c64cbbfd55ca245d93273d1e36b3a014be2805..1fa41621e8280de94716b9a1d9a53fa169e2248d 100644 (file)
--- 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
 ==================