summaryrefslogtreecommitdiff
path: root/support/pydocstrip/README_samples
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /support/pydocstrip/README_samples
Initial commit
Diffstat (limited to 'support/pydocstrip/README_samples')
-rw-r--r--support/pydocstrip/README_samples19
1 files changed, 19 insertions, 0 deletions
diff --git a/support/pydocstrip/README_samples b/support/pydocstrip/README_samples
new file mode 100644
index 0000000000..865ca6fd55
--- /dev/null
+++ b/support/pydocstrip/README_samples
@@ -0,0 +1,19 @@
+This directory contains the samples for `docstrip.py`
+See FILELIST for the details.
+
+Please try one of following codes.
+(Watch for the results saved in ./tempdir before try any other code!)
+
+ docstrip.py -f -j vnr -e "test=0;nopre=1;destdir=./tempdir"
+ docstrip.py -f -j vnr -e "test=1;nopre=1;destdir=./tempdir"
+ docstrip.py -f -j vnr -e "test=0;nopre=1;destdir=./tempdir"
+ docstrip.py -f -j vnr -e "test=0;nopre=0;destdir=./tempdir"
+
+Because we are running a test, we should use the -f option;
+otherwise, the generation occurs only once!
+
+Under LINUX, you may firstly try
+ chmod +x docstrip.py
+
+If you are using Python for WIN32, you may try, for e.g.,
+ "your_python.exe" docstrip.py [...]