WIP

.gitignore

@@ -142,3 +142,6 @@ cython_debug/
 runs/
 workspace/
 .DS_store
+
+# ignore sphinx build directory
+docs/build

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)

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

docs/requirements.txt

@@ -0,0 +1,3 @@
+Sphinx>=2.0.0
+sphinxcontrib-napoleon>=0.7
+sphinx-rtd-theme>=0.4.3

docs/source/conf.py

@@ -0,0 +1,54 @@
+# 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('../..'))
+
+# -- Project information -----------------------------------------------------
+
+project = 'xvision'
+copyright = '2021, Jimmy'
+author = 'Jimmy'
+
+
+# -- 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 = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.viewcode',
+    'sphinxcontrib.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']

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. xvision documentation master file, created by
+   sphinx-quickstart on Tue Apr 13 00:06:12 2021.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to xvision's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/modules.rst

@@ -0,0 +1,7 @@
+xvision
+=======
+
+.. toctree::
+   :maxdepth: 4
+
+   xvision

docs/source/xvision.api.rst

@@ -0,0 +1,45 @@
+xvision.api package
+===================
+
+Submodules
+----------
+
+xvision.api.detector module
+---------------------------
+
+.. automodule:: xvision.api.detector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.api.face\_alignmentor module
+------------------------------------
+
+.. automodule:: xvision.api.face_alignmentor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.api.face\_detector module
+---------------------------------
+
+.. automodule:: xvision.api.face_detector
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.api.face\_tracker module
+--------------------------------
+
+.. automodule:: xvision.api.face_tracker
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: xvision.api
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/xvision.assets.rst

@@ -0,0 +1,21 @@
+xvision.assets package
+======================
+
+Submodules
+----------
+
+xvision.assets.fd module
+------------------------
+
+.. automodule:: xvision.assets.fd
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: xvision.assets
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/xvision.datasets.rst

@@ -0,0 +1,85 @@
+xvision.datasets package
+========================
+
+Submodules
+----------
+
+xvision.datasets.ava module
+---------------------------
+
+.. automodule:: xvision.datasets.ava
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.coco module
+----------------------------
+
+.. automodule:: xvision.datasets.coco
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.ibug module
+----------------------------
+
+.. automodule:: xvision.datasets.ibug
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.jdlmk module
+-----------------------------
+
+.. automodule:: xvision.datasets.jdlmk
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.loader module
+------------------------------
+
+.. automodule:: xvision.datasets.loader
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.memmap module
+------------------------------
+
+.. automodule:: xvision.datasets.memmap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.voc module
+---------------------------
+
+.. automodule:: xvision.datasets.voc
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.wflw module
+----------------------------
+
+.. automodule:: xvision.datasets.wflw
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.datasets.wider module
+-----------------------------
+
+.. automodule:: xvision.datasets.wider
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: xvision.datasets
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/xvision.models.fa.rst

@@ -0,0 +1,29 @@
+xvision.models.fa package
+=========================
+
+Submodules
+----------
+
+xvision.models.fa.mbv2 module
+-----------------------------
+
+.. automodule:: xvision.models.fa.mbv2
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.models.fa.resnet module
+-------------------------------
+
+.. automodule:: xvision.models.fa.resnet
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: xvision.models.fa
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/xvision.models.fd.rst

@@ -0,0 +1,37 @@
+xvision.models.fd package
+=========================
+
+Submodules
+----------
+
+xvision.models.fd.predictor module
+----------------------------------
+
+.. automodule:: xvision.models.fd.predictor
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.models.fd.rfb module
+----------------------------
+
+.. automodule:: xvision.models.fd.rfb
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+xvision.models.fd.slim module
+-----------------------------
+
+.. automodule:: xvision.models.fd.slim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: xvision.models.fd
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/xvision.models.od.rst

@@ -0,0 +1,10 @@
+xvision.models.od package
+=========================
+
+Module contents
+---------------
+
+.. automodule:: xvision.models.od
+   :members:
+   :undoc-members:
+   :show-inheritance: