diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# 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) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..6247f7e --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..c8c1c64 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,67 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +sys.path.insert(0, os.path.abspath(os.path.join("..", ".."))) + +from filezen.version import VERSION + + +# -- Project information ----------------------------------------------------- + +project = 'FileZen' +copyright = '2020, Abhinav Anand' +author = 'Abhinav Anand' + +# The full version, including alpha/beta/rc tags +release = VERSION + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + # XXX: Not sure which one is better here. + # `sphinx_automodapi.automodapi` generates nice looking API + # docs but is not built-in, while both being conversely true + # for `sphinx.ext.autodoc`. + "sphinx.ext.autodoc", + # "sphinx_automodapi.automodapi", + + "sphinxcontrib.programoutput", + # This adds support for Googley formatted docstrings as they are + # easier to read than reStructuredText.. + "sphinx.ext.napoleon" +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] diff --git a/docs/source/filezen.advancedScanner.rst b/docs/source/filezen.advancedScanner.rst new file mode 100644 index 0000000..1995803 --- /dev/null +++ b/docs/source/filezen.advancedScanner.rst @@ -0,0 +1,21 @@ +filezen.advancedScanner package +=============================== + +Submodules +---------- + +filezen.advancedScanner.advancedscanner module +---------------------------------------------- + +.. automodule:: filezen.advancedScanner.advancedscanner + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: filezen.advancedScanner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/filezen.frequencyHeap.rst b/docs/source/filezen.frequencyHeap.rst new file mode 100644 index 0000000..4dde086 --- /dev/null +++ b/docs/source/filezen.frequencyHeap.rst @@ -0,0 +1,21 @@ +filezen.frequencyHeap package +============================= + +Submodules +---------- + +filezen.frequencyHeap.frequencyheap module +------------------------------------------ + +.. automodule:: filezen.frequencyHeap.frequencyheap + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: filezen.frequencyHeap + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/filezen.rst b/docs/source/filezen.rst new file mode 100644 index 0000000..dbdf1c5 --- /dev/null +++ b/docs/source/filezen.rst @@ -0,0 +1,32 @@ +filezen package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + filezen.advancedScanner + filezen.frequencyHeap + filezen.scanner + filezen.simpleScanner + +Submodules +---------- + +filezen.version module +---------------------- + +.. automodule:: filezen.version + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: filezen + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/filezen.scanner.rst b/docs/source/filezen.scanner.rst new file mode 100644 index 0000000..bc80b6d --- /dev/null +++ b/docs/source/filezen.scanner.rst @@ -0,0 +1,21 @@ +filezen.scanner package +======================= + +Submodules +---------- + +filezen.scanner.scanner module +------------------------------ + +.. automodule:: filezen.scanner.scanner + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: filezen.scanner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/filezen.simpleScanner.rst b/docs/source/filezen.simpleScanner.rst new file mode 100644 index 0000000..a425f4b --- /dev/null +++ b/docs/source/filezen.simpleScanner.rst @@ -0,0 +1,29 @@ +filezen.simpleScanner package +============================= + +Submodules +---------- + +filezen.simpleScanner.extensionMapper module +-------------------------------------------- + +.. automodule:: filezen.simpleScanner.extensionMapper + :members: + :undoc-members: + :show-inheritance: + +filezen.simpleScanner.simplescanner module +------------------------------------------ + +.. automodule:: filezen.simpleScanner.simplescanner + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: filezen.simpleScanner + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..26bed1d --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,7 @@ +filezen +======= + +.. toctree:: + :maxdepth: 4 + + filezen diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 0000000..26bed1d --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,7 @@ +filezen +======= + +.. toctree:: + :maxdepth: 4 + + filezen