add sphinx autogenerated documentation

akgyzv · Apr 27, 2019 · d4c4a2d · d4c4a2d
1 parent 1b8abc0
commit d4c4a2d
Show file tree

Hide file tree

Showing 13 changed files with 799 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -9,6 +9,7 @@ venv
 .venv
 archivebox/.venv
 archivebox/venv
+archivebox/docs/_build
 
 # vim
 .swp*

diff --git a/Pipfile b/Pipfile
@@ -9,6 +9,9 @@ flake8 = "*"
 mypy = "*"
 django-stubs = "*"
 setuptools = "*"
+sphinx = "*"
+recommonmark = "*"
+sphinx-py3doc-enhanced-theme = "*"
 
 [packages]
 dataclasses = "*"

diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/archivebox/docs/Makefile b/archivebox/docs/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+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)
-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ venv @@
     .venv
     archivebox/.venv
     archivebox/venv
+    archivebox/docs/_build
     # vim
     .swp*
@@ Expand Down @@