add sphinx autogenerated documentation

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)

archivebox/docs/archivebox.cli.rst

@@ -0,0 +1,126 @@
+archivebox.cli package
+======================
+
+Submodules
+----------
+
+archivebox.cli.archivebox module
+--------------------------------
+
+.. automodule:: archivebox.cli.archivebox
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_add module
+-------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_add
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_config module
+----------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_help module
+--------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_help
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_info module
+--------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_info
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_init module
+--------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_init
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_list module
+--------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_list
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_manage module
+----------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_manage
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_remove module
+----------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_remove
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_schedule module
+------------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_schedule
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_server module
+----------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_server
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_shell module
+---------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_shell
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_update module
+----------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_update
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.cli.archivebox\_version module
+-----------------------------------------
+
+.. automodule:: archivebox.cli.archivebox_version
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: archivebox.cli
+    :members:
+    :undoc-members:
+    :show-inheritance:

archivebox/docs/archivebox.core.migrations.rst

@@ -0,0 +1,30 @@
+archivebox.core.migrations package
+==================================
+
+Submodules
+----------
+
+archivebox.core.migrations.0001\_initial module
+-----------------------------------------------
+
+.. automodule:: archivebox.core.migrations.0001_initial
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.migrations.0002\_auto\_20190417\_0739 module
+------------------------------------------------------------
+
+.. automodule:: archivebox.core.migrations.0002_auto_20190417_0739
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: archivebox.core.migrations
+    :members:
+    :undoc-members:
+    :show-inheritance:

archivebox/docs/archivebox.core.rst

@@ -0,0 +1,93 @@
+archivebox.core package
+=======================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    archivebox.core.migrations
+
+Submodules
+----------
+
+archivebox.core.admin module
+----------------------------
+
+.. automodule:: archivebox.core.admin
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.apps module
+---------------------------
+
+.. automodule:: archivebox.core.apps
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.models module
+-----------------------------
+
+.. automodule:: archivebox.core.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.settings module
+-------------------------------
+
+.. automodule:: archivebox.core.settings
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.tests module
+----------------------------
+
+.. automodule:: archivebox.core.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.urls module
+---------------------------
+
+.. automodule:: archivebox.core.urls
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.views module
+----------------------------
+
+.. automodule:: archivebox.core.views
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.welcome\_message module
+---------------------------------------
+
+.. automodule:: archivebox.core.welcome_message
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.core.wsgi module
+---------------------------
+
+.. automodule:: archivebox.core.wsgi
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: archivebox.core
+    :members:
+    :undoc-members:
+    :show-inheritance:

archivebox/docs/archivebox.legacy.rst

@@ -0,0 +1,93 @@
+archivebox.legacy package
+=========================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    archivebox.legacy.storage
+
+Submodules
+----------
+
+archivebox.legacy.archive\_methods module
+-----------------------------------------
+
+.. automodule:: archivebox.legacy.archive_methods
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.config module
+-------------------------------
+
+.. automodule:: archivebox.legacy.config
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.config\_stubs module
+--------------------------------------
+
+.. automodule:: archivebox.legacy.config_stubs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.index module
+------------------------------
+
+.. automodule:: archivebox.legacy.index
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.logs module
+-----------------------------
+
+.. automodule:: archivebox.legacy.logs
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.main module
+-----------------------------
+
+.. automodule:: archivebox.legacy.main
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.parse module
+------------------------------
+
+.. automodule:: archivebox.legacy.parse
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.schema module
+-------------------------------
+
+.. automodule:: archivebox.legacy.schema
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.util module
+-----------------------------
+
+.. automodule:: archivebox.legacy.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: archivebox.legacy
+    :members:
+    :undoc-members:
+    :show-inheritance:

archivebox/docs/archivebox.legacy.storage.rst

@@ -0,0 +1,38 @@
+archivebox.legacy.storage package
+=================================
+
+Submodules
+----------
+
+archivebox.legacy.storage.html module
+-------------------------------------
+
+.. automodule:: archivebox.legacy.storage.html
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.storage.json module
+-------------------------------------
+
+.. automodule:: archivebox.legacy.storage.json
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.legacy.storage.sql module
+------------------------------------
+
+.. automodule:: archivebox.legacy.storage.sql
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: archivebox.legacy.storage
+    :members:
+    :undoc-members:
+    :show-inheritance:

archivebox/docs/archivebox.rst

@@ -0,0 +1,39 @@
+archivebox package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    archivebox.cli
+    archivebox.core
+    archivebox.legacy
+
+Submodules
+----------
+
+archivebox.manage module
+------------------------
+
+.. automodule:: archivebox.manage
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+archivebox.tests module
+-----------------------
+
+.. automodule:: archivebox.tests
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: archivebox
+    :members:
+    :undoc-members:
+    :show-inheritance:

archivebox/docs/conf.py

@@ -0,0 +1,105 @@
+# 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:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- 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('.'))
+
+import django
+import sphinx_py3doc_enhanced_theme
+
+sys.path.insert(0, os.path.abspath('../'))
+sys.path.insert(0, os.path.abspath('.'))
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "core.settings")
+django.setup()
+
+# -- Project information -----------------------------------------------------
+
+project = 'ArchiveBox'
+copyright = '2019, Nick Sweeting'
+author = 'Nick Sweeting'
+
+# The full version, including alpha/beta/rc tags
+release = 'v0.4.0'
+
+
+# -- 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.napoleon',
+    'sphinx.ext.viewcode',
+    # 'sphinxcontrib.blockdiag'
+    'recommonmark'
+]
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
+master_doc = 'index'
+napoleon_google_docstring = True
+napoleon_use_param = True
+napoleon_use_ivar = False
+napoleon_use_rtype = True
+napoleon_include_special_with_doc = False
+
+# 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 = ['_build', 'Thumbs.db', '.DS_Store', 'data', 'output', 'templates', 'tests']
+
+
+# -- 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_py3doc_enhanced_theme'
+html_theme_path = [sphinx_py3doc_enhanced_theme.get_html_theme_path()]
+
+texinfo_documents = [
+    (master_doc, 'archivebox', 'archivebox Documentation',
+     author, 'archivebox', 'The open-source self-hosted internet archive.',
+     'Miscellaneous'),
+]
+
+html_theme_options = {
+    'githuburl': 'https://github.com/ionelmc/sphinx-py3doc-enhanced-theme/',
+    'bodyfont': '"Lucida Grande",Arial,sans-serif',
+    'headfont': '"Lucida Grande",Arial,sans-serif',
+    'codefont': '"Deja Vu Sans Mono",consolas,monospace,sans-serif',
+    'linkcolor': '#0072AA',
+    'visitedlinkcolor': '#6363bb',
+    'extrastyling': False,
+    'sidebarwide': True
+
+}
+pygments_style = 'friendly'
+
+# 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']
+
+
+man_pages = [
+    (master_doc, 'archivebox', 'archivebox Documentation',
+     [author], 1)
+]

archivebox/docs/index.rst

@@ -0,0 +1,27 @@
+.. ArchiveBox documentation master file, created by
+   sphinx-quickstart on Fri Apr 26 20:28:45 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to ArchiveBox's documentation!
+======================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   archivebox
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+.. automodule:: archivebox
+   :members:
+   :inherited-members:
+   :show-inheritance:
+
+   archivebox

archivebox/docs/modules.rst

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