Issue #80: Use sphinx-click for docs

Nekmo · May 21, 2020 · 8538670 · 8538670
1 parent c2d2e94
commit 8538670
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 36 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -52,6 +52,7 @@ clean:
 	rm -rf $(BUILDDIR)/*
 
 html:
+	rm -rf $(BUILDDIR)
 	$(SPHINXAPIDOC) -o . ../dirhunt
 	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
 	@echo

diff --git a/docs/conf.py b/docs/conf.py
@@ -42,7 +42,11 @@
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinx_click.ext'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

diff --git a/docs/usage.rst b/docs/usage.rst
@@ -10,41 +10,9 @@ To see the available help run::
     $ dirhunt --help
 
 
-Example::
-
-    Usage: dirhunt [OPTIONS] [URLS]...
-
-      One or more domain or urls. Load urls from files using the /full/path or
-      ./relative/path.
-
-    Options:
-      -t, --threads INTEGER           Number of threads to use.
-      -x, --exclude-flags TEXT        Exclude results with these flags. See
-                                      documentation.
-      -i, --include-flags TEXT        Only include results with these flags. See
-                                      documentation.
-      -e, --interesting-extensions TEXT
-                                      The files found with these extensions are
-                                      interesting
-      -f, --interesting-files TEXT    The files with these names are interesting
-      --stdout-flags TEXT             Return only in stdout the urls of these
-                                      flags
-      --progress-enabled / --progress-disabled
-      --timeout INTEGER
-      --max-depth INTEGER             Maximum links to follow without increasing
-                                      directories depth
-      --not-follow-subdomains         The subdomains will be ignored
-      --exclude-sources TEXT          Exclude source engines. Possible options:
-                                      robots, virustotal, google
-      -p, --proxies TEXT              Set one or more proxies to alternate between
-                                      them
-      -d, --delay FLOAT               Delay between requests to avoid bans by the
-                                      server
-      --not-allow-redirects           Redirectors will not be followed
-      --limit INTEGER                 Max number of pages processed to search for
-                                      directories.
-      --version
-      --help                          Show this message and exit.
+.. click:: dirhunt.management:hunt
+   :prog: dirhunt
+   :show-nested:
 
 
 Find directories

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -1 +1,2 @@
 Sphinx
+sphinx-click