CI docs

.github/workflows/docs.yml

@@ -4,7 +4,7 @@ name: Deploy Docs to Pages
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["master"]
+    branches: ["master", "docs"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -44,6 +44,7 @@ jobs:
         run: |
           cd docs
           rm -rf code-doc && sphinx-apidoc -o source/code-doc ../fmtree
+          make clean
           make html
       - name: Setup Pages
         uses: actions/configure-pages@v3

docs/source/sample.rst

@@ -35,3 +35,15 @@ Sample Code
                 return nodes
             else:
                 return sorted(nodes, key=lambda node: node.get_filename())
+
+
+===============
+Duplicate Image
+===============
+
+This command can search for duplicate in a directory and remove them.
+
+.. code-block:: bash
+
+    python -m fmtree.image.dup ~/Downloads/images --output_dir ./out --remove_inplace --output_json dup.json -m perceptual-hash
+