Final Sphinx documentation w/ ReadTheDocs

.readthedocs.yaml

@@ -0,0 +1,32 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  apt_packages:
+    - libsndfile1
+    - ffmpeg
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "16"
+    # rust: "1.55"
+    # golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: docs/requirements.txt

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.https://www.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,18 @@
+iopath>=0.1.8
+nlpaug==1.1.3
+numpy>=1.19.5
+Pillow>=8.2.0
+python-magic>=0.4.22
+regex>=2021.4.4
+vidgear>=0.2.4
+audioread>=2.1.9
+ffmpeg-python>=0.2.0
+librosa>=0.8.1
+opencv-python>=4.5.2.54
+SoundFile>=0.10.3.post1
+torch>=1.9.0
+torchaudio>=0.9.0
+sphinx
+sphinx-epytext
+sphinx-autodoc-typehints
+myst-parser

docs/source/README.md

@@ -0,0 +1,4 @@
+# Get Started
+
+```{include} ../../README.md
+```

docs/source/README_audio.md

@@ -0,0 +1,2 @@
+```{include} ../../augly/audio/README.md
+```

docs/source/README_image.md

@@ -0,0 +1,2 @@
+```{include} ../../augly/image/README.md
+```

docs/source/README_text.md

@@ -0,0 +1,2 @@
+```{include} ../../augly/text/README.md
+```

docs/source/README_video.md

@@ -0,0 +1,2 @@
+```{include} ../../augly/video/README.md
+```

docs/source/augly.audio.rst

@@ -0,0 +1,53 @@
+augly.audio package
+===================
+
+Submodules
+----------
+
+augly.audio.composition module
+------------------------------
+
+.. automodule:: augly.audio.composition
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.audio.functional module
+-----------------------------
+
+.. automodule:: augly.audio.functional
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.audio.intensity module
+----------------------------
+
+.. automodule:: augly.audio.intensity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.audio.transforms module
+-----------------------------
+
+.. automodule:: augly.audio.transforms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.audio.utils module
+------------------------
+
+.. automodule:: augly.audio.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: augly.audio
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/augly.image.rst

@@ -0,0 +1,61 @@
+augly.image package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   augly.image.utils
+
+Submodules
+----------
+
+augly.image.composition module
+------------------------------
+
+.. automodule:: augly.image.composition
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.image.functional module
+-----------------------------
+
+.. automodule:: augly.image.functional
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.image.helpers module
+--------------------------
+
+.. automodule:: augly.image.helpers
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.image.intensity module
+----------------------------
+
+.. automodule:: augly.image.intensity
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.image.transforms module
+-----------------------------
+
+.. automodule:: augly.image.transforms
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: augly.image
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/augly.image.utils.rst

@@ -0,0 +1,37 @@
+augly.image.utils package
+=========================
+
+Submodules
+----------
+
+augly.image.utils.bboxes module
+-------------------------------
+
+.. automodule:: augly.image.utils.bboxes
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.image.utils.metadata module
+---------------------------------
+
+.. automodule:: augly.image.utils.metadata
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+augly.image.utils.utils module
+------------------------------
+
+.. automodule:: augly.image.utils.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: augly.image.utils
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/augly.rst

@@ -0,0 +1,23 @@
+augly package
+=============
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   augly.audio
+   augly.image
+   augly.tests
+   augly.text
+   augly.utils
+   augly.video
+
+Module contents
+---------------
+
+.. automodule:: augly
+   :members:
+   :undoc-members:
+   :show-inheritance: