1
0
mirror of https://github.com/pirate/ArchiveBox.git synced 2025-08-23 14:44:21 +02:00

add latest sphinx build

Nick Sweeting
2024-10-04 15:25:22 -07:00
parent e159c0aad0
commit 6a95aeb5de
24 changed files with 1019 additions and 1 deletions

@@ -391,7 +391,7 @@ DATA_DIR = '~/archivebox/data'
os.chdir(DATA_DIR)
# you must import and setup django first to establish a DB connection
from archivebox.config import setup_django
from archivebox.config.legacy import setup_django
setup_django()
# then you can import all the main functions

@@ -0,0 +1,10 @@
archivebox.abid\_utils.migrations package
=========================================
Module contents
---------------
.. automodule:: archivebox.abid_utils.migrations
:members:
:undoc-members:
:show-inheritance:

61
archivebox.abid_utils.rst Normal file

@@ -0,0 +1,61 @@
archivebox.abid\_utils package
==============================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.abid_utils.migrations
Submodules
----------
archivebox.abid\_utils.abid module
----------------------------------
.. automodule:: archivebox.abid_utils.abid
:members:
:undoc-members:
:show-inheritance:
archivebox.abid\_utils.admin module
-----------------------------------
.. automodule:: archivebox.abid_utils.admin
:members:
:undoc-members:
:show-inheritance:
archivebox.abid\_utils.apps module
----------------------------------
.. automodule:: archivebox.abid_utils.apps
:members:
:undoc-members:
:show-inheritance:
archivebox.abid\_utils.models module
------------------------------------
.. automodule:: archivebox.abid_utils.models
:members:
:undoc-members:
:show-inheritance:
archivebox.abid\_utils.tests module
-----------------------------------
.. automodule:: archivebox.abid_utils.tests
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.abid_utils
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,117 @@
archivebox.abx.archivebox package
=================================
Submodules
----------
archivebox.abx.archivebox.base\_admindataview module
----------------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_admindataview
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_binary module
---------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_binary
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_check module
--------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_check
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_configset module
------------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_configset
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_extractor module
------------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_extractor
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_hook module
-------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_hook
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_plugin module
---------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_plugin
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_queue module
--------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_queue
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_replayer module
-----------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_replayer
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.base\_searchbackend module
----------------------------------------------------
.. automodule:: archivebox.abx.archivebox.base_searchbackend
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.hookspec module
-----------------------------------------
.. automodule:: archivebox.abx.archivebox.hookspec
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.toml\_util module
-------------------------------------------
.. automodule:: archivebox.abx.archivebox.toml_util
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.archivebox.use module
------------------------------------
.. automodule:: archivebox.abx.archivebox.use
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.abx.archivebox
:members:
:undoc-members:
:show-inheritance:

37
archivebox.abx.django.rst Normal file

@@ -0,0 +1,37 @@
archivebox.abx.django package
=============================
Submodules
----------
archivebox.abx.django.apps module
---------------------------------
.. automodule:: archivebox.abx.django.apps
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.django.hookspec module
-------------------------------------
.. automodule:: archivebox.abx.django.hookspec
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.django.use module
--------------------------------
.. automodule:: archivebox.abx.django.use
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.abx.django
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.abx.pydantic\_pkgr package
=====================================
Submodules
----------
archivebox.abx.pydantic\_pkgr.hookspec module
---------------------------------------------
.. automodule:: archivebox.abx.pydantic_pkgr.hookspec
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.abx.pydantic_pkgr
:members:
:undoc-members:
:show-inheritance:

39
archivebox.abx.rst Normal file

@@ -0,0 +1,39 @@
archivebox.abx package
======================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.abx.archivebox
archivebox.abx.django
archivebox.abx.pydantic_pkgr
Submodules
----------
archivebox.abx.hookspec module
------------------------------
.. automodule:: archivebox.abx.hookspec
:members:
:undoc-members:
:show-inheritance:
archivebox.abx.manager module
-----------------------------
.. automodule:: archivebox.abx.manager
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.abx
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,85 @@
archivebox.api.migrations package
=================================
Submodules
----------
archivebox.api.migrations.0001\_initial module
----------------------------------------------
.. automodule:: archivebox.api.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0002\_alter\_apitoken\_options module
---------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0002_alter_apitoken_options
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0003\_rename\_user\_apitoken\_created\_by\_apitoken\_abid\_and\_more module
-----------------------------------------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0003_rename_user_apitoken_created_by_apitoken_abid_and_more
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0004\_alter\_apitoken\_id\_alter\_apitoken\_uuid module
---------------------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0004_alter_apitoken_id_alter_apitoken_uuid
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0005\_remove\_apitoken\_uuid\_remove\_outboundwebhook\_uuid\_and\_more module
-------------------------------------------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0005_remove_apitoken_uuid_remove_outboundwebhook_uuid_and_more
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0006\_remove\_outboundwebhook\_uuid\_apitoken\_id\_and\_more module
---------------------------------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0006_remove_outboundwebhook_uuid_apitoken_id_and_more
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0007\_alter\_apitoken\_created\_by module
-------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0007_alter_apitoken_created_by
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0008\_alter\_apitoken\_created\_alter\_apitoken\_created\_by\_and\_more module
--------------------------------------------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0008_alter_apitoken_created_alter_apitoken_created_by_and_more
:members:
:undoc-members:
:show-inheritance:
archivebox.api.migrations.0009\_rename\_created\_apitoken\_created\_at\_and\_more module
----------------------------------------------------------------------------------------
.. automodule:: archivebox.api.migrations.0009_rename_created_apitoken_created_at_and_more
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.api.migrations
:members:
:undoc-members:
:show-inheritance:

93
archivebox.api.rst Normal file

@@ -0,0 +1,93 @@
archivebox.api package
======================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.api.migrations
Submodules
----------
archivebox.api.apps module
--------------------------
.. automodule:: archivebox.api.apps
:members:
:undoc-members:
:show-inheritance:
archivebox.api.auth module
--------------------------
.. automodule:: archivebox.api.auth
:members:
:undoc-members:
:show-inheritance:
archivebox.api.models module
----------------------------
.. automodule:: archivebox.api.models
:members:
:undoc-members:
:show-inheritance:
archivebox.api.tests module
---------------------------
.. automodule:: archivebox.api.tests
:members:
:undoc-members:
:show-inheritance:
archivebox.api.urls module
--------------------------
.. automodule:: archivebox.api.urls
:members:
:undoc-members:
:show-inheritance:
archivebox.api.v1\_api module
-----------------------------
.. automodule:: archivebox.api.v1_api
:members:
:undoc-members:
:show-inheritance:
archivebox.api.v1\_auth module
------------------------------
.. automodule:: archivebox.api.v1_auth
:members:
:undoc-members:
:show-inheritance:
archivebox.api.v1\_cli module
-----------------------------
.. automodule:: archivebox.api.v1_cli
:members:
:undoc-members:
:show-inheritance:
archivebox.api.v1\_core module
------------------------------
.. automodule:: archivebox.api.v1_core
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.api
:members:
:undoc-members:
:show-inheritance:

69
archivebox.misc.rst Normal file

@@ -0,0 +1,69 @@
archivebox.misc package
=======================
Submodules
----------
archivebox.misc.checks module
-----------------------------
.. automodule:: archivebox.misc.checks
:members:
:undoc-members:
:show-inheritance:
archivebox.misc.debugging module
--------------------------------
.. automodule:: archivebox.misc.debugging
:members:
:undoc-members:
:show-inheritance:
archivebox.misc.logging module
------------------------------
.. automodule:: archivebox.misc.logging
:members:
:undoc-members:
:show-inheritance:
archivebox.misc.system module
-----------------------------
.. automodule:: archivebox.misc.system
:members:
:undoc-members:
:show-inheritance:
archivebox.misc.tests module
----------------------------
.. automodule:: archivebox.misc.tests
:members:
:undoc-members:
:show-inheritance:
archivebox.misc.toml\_util module
---------------------------------
.. automodule:: archivebox.misc.toml_util
:members:
:undoc-members:
:show-inheritance:
archivebox.misc.util module
---------------------------
.. automodule:: archivebox.misc.util
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.misc
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.plugins\_extractor.chrome package
============================================
Submodules
----------
archivebox.plugins\_extractor.chrome.apps module
------------------------------------------------
.. automodule:: archivebox.plugins_extractor.chrome.apps
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_extractor.chrome
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,20 @@
archivebox.plugins\_extractor package
=====================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.plugins_extractor.chrome
archivebox.plugins_extractor.singlefile
archivebox.plugins_extractor.ytdlp
Module contents
---------------
.. automodule:: archivebox.plugins_extractor
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.plugins\_extractor.singlefile.migrations package
===========================================================
Submodules
----------
archivebox.plugins\_extractor.singlefile.migrations.0001\_initial module
------------------------------------------------------------------------
.. automodule:: archivebox.plugins_extractor.singlefile.migrations.0001_initial
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_extractor.singlefile.migrations
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,45 @@
archivebox.plugins\_extractor.singlefile package
================================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.plugins_extractor.singlefile.migrations
Submodules
----------
archivebox.plugins\_extractor.singlefile.apps module
----------------------------------------------------
.. automodule:: archivebox.plugins_extractor.singlefile.apps
:members:
:undoc-members:
:show-inheritance:
archivebox.plugins\_extractor.singlefile.models module
------------------------------------------------------
.. automodule:: archivebox.plugins_extractor.singlefile.models
:members:
:undoc-members:
:show-inheritance:
archivebox.plugins\_extractor.singlefile.tasks module
-----------------------------------------------------
.. automodule:: archivebox.plugins_extractor.singlefile.tasks
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_extractor.singlefile
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.plugins\_extractor.ytdlp package
===========================================
Submodules
----------
archivebox.plugins\_extractor.ytdlp.apps module
-----------------------------------------------
.. automodule:: archivebox.plugins_extractor.ytdlp.apps
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_extractor.ytdlp
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.plugins\_search.ripgrep package
==========================================
Submodules
----------
archivebox.plugins\_search.ripgrep.apps module
----------------------------------------------
.. automodule:: archivebox.plugins_search.ripgrep.apps
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_search.ripgrep
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,20 @@
archivebox.plugins\_search package
==================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.plugins_search.ripgrep
archivebox.plugins_search.sonic
archivebox.plugins_search.sqlite
Module contents
---------------
.. automodule:: archivebox.plugins_search
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.plugins\_search.sonic package
========================================
Submodules
----------
archivebox.plugins\_search.sonic.apps module
--------------------------------------------
.. automodule:: archivebox.plugins_search.sonic.apps
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_search.sonic
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,21 @@
archivebox.plugins\_search.sqlite package
=========================================
Submodules
----------
archivebox.plugins\_search.sqlite.apps module
---------------------------------------------
.. automodule:: archivebox.plugins_search.sqlite.apps
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.plugins_search.sqlite
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,10 @@
archivebox.queues.migrations package
====================================
Module contents
---------------
.. automodule:: archivebox.queues.migrations
:members:
:undoc-members:
:show-inheritance:

61
archivebox.queues.rst Normal file

@@ -0,0 +1,61 @@
archivebox.queues package
=========================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.queues.migrations
Submodules
----------
archivebox.queues.apps module
-----------------------------
.. automodule:: archivebox.queues.apps
:members:
:undoc-members:
:show-inheritance:
archivebox.queues.semaphores module
-----------------------------------
.. automodule:: archivebox.queues.semaphores
:members:
:undoc-members:
:show-inheritance:
archivebox.queues.settings module
---------------------------------
.. automodule:: archivebox.queues.settings
:members:
:undoc-members:
:show-inheritance:
archivebox.queues.supervisor\_util module
-----------------------------------------
.. automodule:: archivebox.queues.supervisor_util
:members:
:undoc-members:
:show-inheritance:
archivebox.queues.tasks module
------------------------------
.. automodule:: archivebox.queues.tasks
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.queues
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,10 @@
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.migrations package
==================================================================
Module contents
---------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.migrations
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,157 @@
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr package
=======================================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.vendor.pydantic-pkgr.pydantic_pkgr.migrations
Submodules
----------
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.admin module
------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.admin
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.apps module
-----------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.apps
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.base\_types module
------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.base_types
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binary module
-------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binary
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider module
------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider\_ansible module
---------------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider_ansible
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider\_apt module
-----------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider_apt
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider\_brew module
------------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider_brew
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider\_npm module
-----------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider_npm
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider\_pip module
-----------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider_pip
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.binprovider\_pyinfra module
---------------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.binprovider_pyinfra
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.models module
-------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.models
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.semver module
-------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.semver
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.settings module
---------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.settings
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.shallowbinary module
--------------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.shallowbinary
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.tests module
------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.tests
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.pydantic\_pkgr.views module
------------------------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr.views
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.vendor.pydantic-pkgr.pydantic_pkgr
:members:
:undoc-members:
:show-inheritance:

@@ -0,0 +1,37 @@
archivebox.vendor.pydantic\-pkgr package
========================================
Subpackages
-----------
.. toctree::
:maxdepth: 4
archivebox.vendor.pydantic-pkgr.pydantic_pkgr
Submodules
----------
archivebox.vendor.pydantic\-pkgr.manage module
----------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.manage
:members:
:undoc-members:
:show-inheritance:
archivebox.vendor.pydantic\-pkgr.tests module
---------------------------------------------
.. automodule:: archivebox.vendor.pydantic-pkgr.tests
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: archivebox.vendor.pydantic-pkgr
:members:
:undoc-members:
:show-inheritance: