From: Oleg Broytman <phd@phdru.name>
Date: Sat, 15 Apr 2017 22:41:39 +0000 (+0300)
Subject: Initial docs
X-Git-Tag: 0.0.1~3
X-Git-Url: https://git.phdru.name/?p=ppu.git;a=commitdiff_plain;h=5072f4307c3c5521a14c221be7b4358b8e5c07a7

Initial docs
---

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 <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 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
 ==================