docs: add sphinx documentation and add missing documentation

Author: d4l3k

.github/workflows/docs.yaml

@@ -0,0 +1,50 @@
+name: Docs
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Setup Python
+        uses: actions/setup-python@v3
+        with:
+          python-version: "3.10"
+          architecture: x64
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: |
+          set -eux
+
+          sudo apt-get install -y protobuf-compiler
+
+          pip install .[dev] -v
+
+          pip install -r docs/requirements.txt
+      - name: Build Sphinx Docs
+        run: |
+          set -eux
+
+          cd docs
+          make html
+      - name: Upload static files as artifact
+        id: deployment
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html/
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -0,0 +1,8 @@
+src/pytorch-sphinx-theme
+source/examples_*/
+jupyter_execute/
+build/
+
+Dockerfile
+my_component.py
+my_app.py

docs/Makefile

@@ -0,0 +1,36 @@
+
+# Minimal makefile for Sphinx documentation
+# Usage:
+#    make html
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -W
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = torchft
+SOURCEDIR     = source
+BUILDDIR      = build
+VERSION       := $(shell python -c "from importlib.metadata import version; print(version('torchft'))")
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+clean:
+	@echo "Deleting build directory"
+	rm -rf "$(BUILDDIR)"
+	rm -rf "$(SOURCEDIR)/examples_apps" "$(SOURCEDIR)/examples_pipelines"
+
+.PHONY: help Makefile clean livehtml papermill
+
+# 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)
+
+# optional live version
+livehtml:
+	sphinx-autobuild --watch ../torchft --re-ignore ".*(examples_.*|.new|source/.*(Dockerfile|.py))" "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+papermill: html
+	./papermill.sh

docs/requirements.txt

@@ -0,0 +1,8 @@
+sphinx==5.0.1
+-e git+http://github.com/pytorch/pytorch_sphinx_theme.git#egg=pytorch_sphinx_theme
+sphinxcontrib.katex
+matplotlib
+papermill
+ipykernel
+ipython_genutils
+jinja2<=3.0.3

docs/source/_static/img/pytorch-logo-dark.svg

@@ -0,0 +1,4 @@
+.. automodule:: torchft.checkpointing
+    :members:
+    :undoc-members:
+    :show-inheritance: