Add sphinx docs and read the docs configurations

.markdownlint.yaml

@@ -24,7 +24,7 @@ MD033: false
 # If a page is printed, it helps if the URL is viewable.
 MD034: false # Bare URL used
 
-# This is needed for the anomalib tagline in the README
+# This is needed for the tagline in the README
 MD036: false # Emphasis used instead of a header
 
 # Some md files have comments or links at the top of the files.

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/source/conf.py
+
+# Optionally build your docs in additional formats such as PDF and ePub
+formats:
+  - pdf
+  - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

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/README.md

@@ -0,0 +1,15 @@
+# VisualTorch Documentation
+
+This is the source code for the VisualTorch documentation, which is built using sphinx-design and myst parser.
+
+## Installation
+
+```bash
+pip install -r requirements.txt
+```
+
+## Build
+
+```bash
+sphinx-build -b html source build
+```

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
+
+%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
+)
+
+if "%1" == "" goto help
+
+%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,8 @@
+myst-parser
+nbsphinx
+pandoc
+sphinx<7.0  # 7.0 breaks readthedocs builds.
+sphinx_autodoc_typehints
+sphinx_book_theme
+sphinx-copybutton
+sphinx_design

docs/source/conf.py

@@ -0,0 +1,64 @@
+"""Configuration file for the Sphinx documentation builder.
+
+For the full list of built-in configuration values, see the documentation:
+https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+-- Project information -----------------------------------------------------
+https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+"""
+
+from __future__ import annotations
+
+import sys
+from pathlib import Path
+
+# Define the path to your module using Path
+module_path = Path(__file__).parent.parent / "src"
+
+# Insert the path to sys.path
+sys.path.insert(0, str(module_path.resolve()))
+
+project = "VisualTorch"
+copyright = "2024, Willy Fitra Hendria"  # noqa: A001
+author = "Willy Fitra Hendria"
+release = "2024"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx_design",
+    "myst_parser",
+    "nbsphinx",
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
+    "sphinx_copybutton",
+]
+
+myst_enable_extensions = [
+    "colon_fence",
+    # other MyST extensions...
+]
+nbsphinx_allow_errors = True
+templates_path = ["_templates"]
+exclude_patterns: list[str] = []
+
+# Automatic exclusion of prompts from the copies
+# https://sphinx-copybutton.readthedocs.io/en/latest/use.html#automatic-exclusion-of-prompts-from-the-copies
+copybutton_exclude = ".linenos, .gp, .go"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_book_theme"
+# html_logo = ""
+# html_favicon = ""
+html_static_path = ["_static"]
+html_theme_options = {
+    "logo": {
+        "text": "VisualTorch",
+    },
+}

docs/source/index.md

@@ -0,0 +1,5 @@
+# VisualTorch Documentation
+
+VisualTorch aims to help visualize Torch-based neural network architectures. It currently supports generating layered-style and graph-style architectures for PyTorch Sequential and Custom models. This tool is adapted from visualkeras, pytorchviz, and pytorch-summary.
+
+🚧 This documentation is under construction 🚧