├── README.md ├── logo.png ├── _static └── icon.png ├── requirements.txt ├── .gitignore ├── Upgrading-or-Merging-Archives.md ├── apidocs ├── archivebox │ ├── archivebox.manage.md │ ├── archivebox.seeds.views.md │ ├── archivebox.actors.admin.md │ ├── archivebox.crawls.views.md │ ├── archivebox.personas.admin.md │ ├── archivebox.personas.views.md │ ├── archivebox.personas.models.md │ ├── archivebox.core.templatetags.md │ ├── archivebox.machine.md │ ├── archivebox.personas.md │ ├── archivebox.abid_utils.md │ ├── archivebox.queues.md │ ├── archivebox.api.md │ ├── archivebox.misc.md │ ├── archivebox.api.urls.md │ ├── archivebox.core.urls.md │ ├── archivebox.core.admin.md │ ├── archivebox.__main__.md │ ├── archivebox.core.wsgi.md │ ├── archivebox.misc.debugging.md │ ├── archivebox.actors.md │ ├── archivebox.core.apps.md │ ├── archivebox.config.md │ ├── archivebox.search.admin.md │ ├── archivebox.seeds.apps.md │ ├── archivebox.actors.apps.md │ ├── archivebox.crawls.apps.md │ ├── archivebox.core.asgi.md │ ├── archivebox.personas.apps.md │ ├── archivebox.abid_utils.apps.md │ ├── archivebox.misc.paginators.md │ ├── archivebox.index.csv.md │ ├── archivebox.api.apps.md │ ├── archivebox.misc.shell_welcome_message.md │ ├── archivebox.seeds.md │ ├── archivebox.cli.archivebox_help.md │ ├── archivebox.cli.archivebox_init.md │ ├── archivebox.cli.archivebox_list.md │ ├── archivebox.cli.archivebox_shell.md │ ├── archivebox.cli.archivebox_config.md │ ├── archivebox.cli.archivebox_manage.md │ ├── archivebox.cli.archivebox_remove.md │ ├── archivebox.cli.archivebox_server.md │ ├── archivebox.cli.archivebox_status.md │ ├── archivebox.cli.archivebox_install.md │ ├── archivebox.cli.archivebox_oneshot.md │ ├── archivebox.cli.archivebox_version.md │ ├── archivebox.crawls.md │ ├── archivebox.actors.views.md │ ├── archivebox.cli.archivebox_schedule.md │ ├── archivebox.pkgs.md │ ├── archivebox.queues.admin.md │ ├── archivebox.queues.apps.md │ ├── archivebox.monkey_patches.md │ ├── archivebox.cli.archivebox_update.md │ ├── archivebox.machine.apps.md │ ├── archivebox.parsers.medium_rss.md │ ├── archivebox.parsers.generic_rss.md │ ├── archivebox.parsers.pocket_html.md │ ├── archivebox.parsers.shaarli_rss.md │ ├── archivebox.parsers.pinboard_rss.md │ ├── archivebox.parsers.netscape_html.md │ ├── archivebox.parsers.wallabag_atom.md │ ├── archivebox.core.md │ ├── archivebox.cli.archivebox_add.md │ ├── archivebox.queues.tasks.md │ ├── archivebox.parsers.url_list.md │ ├── archivebox.queues.semaphores.md │ ├── archivebox.parsers.generic_txt.md │ ├── archivebox.parsers.generic_jsonl.md │ ├── archivebox.parsers.generic_json.md │ └── archivebox.core.middleware.md ├── abx_plugin_favicon │ ├── abx_plugin_favicon.models.md │ ├── abx_plugin_favicon.favicon.md │ └── abx_plugin_favicon.extractors.md ├── abx_spec_archivebox │ ├── abx_spec_archivebox.states.md │ ├── abx_spec_archivebox.writes.md │ ├── abx_spec_archivebox.reads.md │ ├── abx_spec_archivebox.effects.md │ └── abx_spec_archivebox.events.md ├── abx_plugin_singlefile │ ├── abx_plugin_singlefile.models.md │ ├── abx_plugin_singlefile.singlefile.md │ ├── abx_plugin_singlefile.actors.md │ └── abx_plugin_singlefile.extractors.md ├── abx_plugin_title │ ├── abx_plugin_title.md │ └── abx_plugin_title.extractors.md ├── abx_plugin_default_binproviders │ └── abx_plugin_default_binproviders.md ├── abx_plugin_curl │ ├── abx_plugin_curl.md │ ├── abx_plugin_curl.binaries.md │ └── abx_plugin_curl.headers.md ├── abx_plugin_wget │ ├── abx_plugin_wget.wget_util.md │ ├── abx_plugin_wget.binaries.md │ └── abx_plugin_wget.md ├── abx_plugin_htmltotext │ ├── abx_plugin_htmltotext.md │ └── abx_plugin_htmltotext.config.md ├── abx_plugin_pocket │ └── abx_plugin_pocket.md ├── index.rst ├── abx_plugin_git │ ├── abx_plugin_git.binaries.md │ ├── abx_plugin_git.md │ ├── abx_plugin_git.git.md │ └── abx_plugin_git.extractors.md ├── abx_plugin_chrome │ ├── abx_plugin_chrome.dom.md │ ├── abx_plugin_chrome.pdf.md │ └── abx_plugin_chrome.screenshot.md ├── abx_plugin_archivedotorg │ ├── abx_plugin_archivedotorg.md │ ├── abx_plugin_archivedotorg.archive_org.md │ └── abx_plugin_archivedotorg.config.md ├── abx_plugin_sqlitefts_search │ └── abx_plugin_sqlitefts_search.md ├── abx_plugin_puppeteer │ ├── abx_plugin_puppeteer.binaries.md │ ├── abx_plugin_puppeteer.config.md │ └── abx_plugin_puppeteer.md ├── abx_plugin_playwright │ ├── abx_plugin_playwright.binaries.md │ ├── abx_plugin_playwright.config.md │ └── abx_plugin_playwright.md ├── abx_plugin_mercury │ ├── abx_plugin_mercury.binaries.md │ ├── abx_plugin_mercury.extractors.md │ ├── abx_plugin_mercury.md │ └── abx_plugin_mercury.mercury.md ├── abx_plugin_ytdlp │ ├── abx_plugin_ytdlp.media.md │ └── abx_plugin_ytdlp.md ├── abx_plugin_sonic_search │ └── abx_plugin_sonic_search.binaries.md ├── abx_plugin_ripgrep_search │ ├── abx_plugin_ripgrep_search.binaries.md │ └── abx_plugin_ripgrep_search.md ├── abx_plugin_npm │ └── abx_plugin_npm.config.md ├── abx_plugin_pip │ └── abx_plugin_pip.md └── abx_plugin_readability │ ├── abx_plugin_readability.readability.md │ ├── abx_plugin_readability.extractors.md │ ├── abx_plugin_readability.md │ └── abx_plugin_readability.binaries.md ├── _Footer.md ├── archivebox.rst ├── Makefile ├── .mkdocs.unused ├── mkdocs.yml └── gen_docs_refs.py ├── Donations.md ├── index.rst ├── Contents.rst └── Home.md /README.md: -------------------------------------------------------------------------------- 1 | ../README.md -------------------------------------------------------------------------------- /logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ArchiveBox/docs/HEAD/logo.png -------------------------------------------------------------------------------- /_static/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ArchiveBox/docs/HEAD/_static/icon.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | sphinx-rtd-theme 3 | myst-parser 4 | sphinx-autodoc2 5 | linkify-it-py 6 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | _build/ 2 | .venv 3 | venv/ 4 | .env 5 | .DS_Store 6 | 7 | queue.sqlite3 8 | index.sqlite3 9 | -------------------------------------------------------------------------------- /Upgrading-or-Merging-Archives.md: -------------------------------------------------------------------------------- 1 | Moved to: 2 | 3 | - [[Upgrading]] 4 | - [[Merging Collections]] 5 | - [Database Troubleshooting](./Troubleshooting#database) -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.manage.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.manage` 2 | 3 | ```{py:module} archivebox.manage 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.manage 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.seeds.views.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.seeds.views` 2 | 3 | ```{py:module} archivebox.seeds.views 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.seeds.views 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.actors.admin.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.actors.admin` 2 | 3 | ```{py:module} archivebox.actors.admin 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.actors.admin 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.crawls.views.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.crawls.views` 2 | 3 | ```{py:module} archivebox.crawls.views 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.crawls.views 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.personas.admin.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.personas.admin` 2 | 3 | ```{py:module} archivebox.personas.admin 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.personas.admin 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.personas.views.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.personas.views` 2 | 3 | ```{py:module} archivebox.personas.views 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.personas.views 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.personas.models.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.personas.models` 2 | 3 | ```{py:module} archivebox.personas.models 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.personas.models 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /_Footer.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | [✏️ Help improve our documentation...](https://github.com/ArchiveBox/ArchiveBox/issues/new?template=3-documentation_change.yml) 4 | 5 |
6 | 7 | ![](https://imgur.zervice.io/8y6hvZa.png) 8 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_favicon/abx_plugin_favicon.models.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_favicon.models` 2 | 3 | ```{py:module} abx_plugin_favicon.models 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_favicon.models 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/abx_spec_archivebox/abx_spec_archivebox.states.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_spec_archivebox.states` 2 | 3 | ```{py:module} abx_spec_archivebox.states 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_spec_archivebox.states 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/abx_spec_archivebox/abx_spec_archivebox.writes.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_spec_archivebox.writes` 2 | 3 | ```{py:module} abx_spec_archivebox.writes 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_spec_archivebox.writes 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_singlefile/abx_plugin_singlefile.models.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_singlefile.models` 2 | 3 | ```{py:module} abx_plugin_singlefile.models 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_singlefile.models 7 | :allowtitles: 8 | ``` 9 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.templatetags.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.templatetags` 2 | 3 | ```{py:module} archivebox.core.templatetags 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.templatetags 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.core.templatetags.core_tags 17 | ``` 18 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.machine.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.machine` 2 | 3 | ```{py:module} archivebox.machine 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.machine 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.machine.models 17 | archivebox.machine.apps 18 | archivebox.machine.admin 19 | archivebox.machine.detect 20 | ``` 21 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.personas.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.personas` 2 | 3 | ```{py:module} archivebox.personas 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.personas 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.personas.models 17 | archivebox.personas.apps 18 | archivebox.personas.admin 19 | archivebox.personas.views 20 | ``` 21 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.abid_utils.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.abid_utils` 2 | 3 | ```{py:module} archivebox.abid_utils 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.abid_utils 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.abid_utils.models 17 | archivebox.abid_utils.apps 18 | archivebox.abid_utils.admin 19 | archivebox.abid_utils.abid 20 | ``` 21 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.queues.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.queues` 2 | 3 | ```{py:module} archivebox.queues 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.queues 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.queues.tasks 17 | archivebox.queues.semaphores 18 | archivebox.queues.apps 19 | archivebox.queues.admin 20 | archivebox.queues.supervisor_util 21 | ``` 22 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.api.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.api` 2 | 3 | ```{py:module} archivebox.api 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.api 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.api.auth 17 | archivebox.api.v1_auth 18 | archivebox.api.v1_api 19 | archivebox.api.models 20 | archivebox.api.v1_cli 21 | archivebox.api.v1_actors 22 | archivebox.api.v1_core 23 | archivebox.api.apps 24 | archivebox.api.admin 25 | archivebox.api.urls 26 | ``` 27 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.misc.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.misc` 2 | 3 | ```{py:module} archivebox.misc 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.misc 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.misc.logging 17 | archivebox.misc.system 18 | archivebox.misc.shell_welcome_message 19 | archivebox.misc.util 20 | archivebox.misc.checks 21 | archivebox.misc.paginators 22 | archivebox.misc.debugging 23 | archivebox.misc.toml_util 24 | archivebox.misc.serve_static 25 | ``` 26 | -------------------------------------------------------------------------------- /archivebox.rst: -------------------------------------------------------------------------------- 1 | archivebox package 2 | ================== 3 | .. toctree:: 4 | archivebox.core 5 | archivebox.cli 6 | archivebox.api 7 | archivebox.machine 8 | archivebox.extractors 9 | archivebox.index 10 | archivebox.parsers 11 | archivebox.misc 12 | archivebox.abid_utils 13 | archivebox.queues 14 | archivebox.plugins_extractor 15 | archivebox.plugins_pkg 16 | archivebox.plugins_auth 17 | archivebox.plugins_search 18 | 19 | 20 | archivebox.main 21 | --------------- 22 | .. automodule:: archivebox.main 23 | :members: 24 | :undoc-members: 25 | :show-inheritance: 26 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | SOURCEDIR = . 8 | BUILDDIR = _build 9 | 10 | # Put it first so that "make" without argument is like "make help". 11 | help: 12 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 13 | 14 | .PHONY: help Makefile 15 | 16 | # Catch-all target: route all unknown targets to Sphinx using the new 17 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 18 | %: Makefile 19 | @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 20 | -------------------------------------------------------------------------------- /.mkdocs.unused/mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: ArchiveBox 2 | site_url: https://github.com/ArchiveBox/ArchiveBox 3 | 4 | theme: 5 | name: material 6 | 7 | 8 | 9 | plugins: 10 | - exclude: 11 | glob: 12 | - archivebox/vendor 13 | - data/ 14 | - data*/ 15 | - '*.sqlite3' 16 | - deb_dist/ 17 | - brew_dist/ 18 | - dist/ 19 | - search 20 | - autorefs 21 | - mkdocstrings: 22 | handlers: 23 | python: 24 | options: 25 | show_submodules: true 26 | import: 27 | - url: https://docs.python-requests.org/en/master/objects.inv 28 | domains: [std, py] 29 | 30 | - gen-files: 31 | scripts: 32 | - gen_docs_refs.py 33 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.api.urls.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.api.urls` 2 | 3 | ```{py:module} archivebox.api.urls 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.api.urls 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Data 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`urlpatterns ` 19 | - ```{autodoc2-docstring} archivebox.api.urls.urlpatterns 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:data} urlpatterns 27 | :canonical: archivebox.api.urls.urlpatterns 28 | :value: > 29 | None 30 | 31 | ```{autodoc2-docstring} archivebox.api.urls.urlpatterns 32 | ``` 33 | 34 | ```` 35 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.urls.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.urls` 2 | 3 | ```{py:module} archivebox.core.urls 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.urls 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Data 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`urlpatterns ` 19 | - ```{autodoc2-docstring} archivebox.core.urls.urlpatterns 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:data} urlpatterns 27 | :canonical: archivebox.core.urls.urlpatterns 28 | :value: > 29 | None 30 | 31 | ```{autodoc2-docstring} archivebox.core.urls.urlpatterns 32 | ``` 33 | 34 | ```` 35 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.admin.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.admin` 2 | 3 | ```{py:module} archivebox.core.admin 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.admin 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`register_admin ` 19 | - ```{autodoc2-docstring} archivebox.core.admin.register_admin 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:function} register_admin(admin_site) 27 | :canonical: archivebox.core.admin.register_admin 28 | 29 | ```{autodoc2-docstring} archivebox.core.admin.register_admin 30 | ``` 31 | ```` 32 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.__main__.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.__main__` 2 | 3 | ```{py:module} archivebox.__main__ 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.__main__ 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Data 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ASCII_LOGO_MINI ` 19 | - ```{autodoc2-docstring} archivebox.__main__.ASCII_LOGO_MINI 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:data} ASCII_LOGO_MINI 27 | :canonical: archivebox.__main__.ASCII_LOGO_MINI 28 | :value: 29 | 30 | ```{autodoc2-docstring} archivebox.__main__.ASCII_LOGO_MINI 31 | ``` 32 | 33 | ```` 34 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.wsgi.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.wsgi` 2 | 3 | ```{py:module} archivebox.core.wsgi 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.wsgi 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Data 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`application ` 19 | - ```{autodoc2-docstring} archivebox.core.wsgi.application 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:data} application 27 | :canonical: archivebox.core.wsgi.application 28 | :value: > 29 | 'get_wsgi_application(...)' 30 | 31 | ```{autodoc2-docstring} archivebox.core.wsgi.application 32 | ``` 33 | 34 | ```` 35 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.misc.debugging.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.misc.debugging` 2 | 3 | ```{py:module} archivebox.misc.debugging 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.misc.debugging 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`timed_function ` 19 | - ```{autodoc2-docstring} archivebox.misc.debugging.timed_function 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:function} timed_function(func) 27 | :canonical: archivebox.misc.debugging.timed_function 28 | 29 | ```{autodoc2-docstring} archivebox.misc.debugging.timed_function 30 | ``` 31 | ```` 32 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_title/abx_plugin_title.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_title` 2 | 3 | ```{py:module} abx_plugin_title 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_title 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_title.extractors 17 | abx_plugin_title.extractor 18 | ``` 19 | 20 | ## Package Contents 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`get_EXTRACTORS ` 29 | - ```{autodoc2-docstring} abx_plugin_title.get_EXTRACTORS 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | ````{py:function} get_EXTRACTORS() 37 | :canonical: abx_plugin_title.get_EXTRACTORS 38 | 39 | ```{autodoc2-docstring} abx_plugin_title.get_EXTRACTORS 40 | ``` 41 | ```` 42 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_default_binproviders/abx_plugin_default_binproviders.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_default_binproviders` 2 | 3 | ```{py:module} abx_plugin_default_binproviders 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_default_binproviders 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_BINPROVIDERS ` 19 | - ```{autodoc2-docstring} abx_plugin_default_binproviders.get_BINPROVIDERS 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:function} get_BINPROVIDERS() -> typing.Dict[str, abx_pkg.BinProvider] 27 | :canonical: abx_plugin_default_binproviders.get_BINPROVIDERS 28 | 29 | ```{autodoc2-docstring} abx_plugin_default_binproviders.get_BINPROVIDERS 30 | ``` 31 | ```` 32 | -------------------------------------------------------------------------------- /apidocs/abx_spec_archivebox/abx_spec_archivebox.reads.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_spec_archivebox.reads` 2 | 3 | ```{py:module} abx_spec_archivebox.reads 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_spec_archivebox.reads 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_scope_config ` 19 | - ```{autodoc2-docstring} abx_spec_archivebox.reads.get_scope_config 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | ````{py:function} get_scope_config(defaults: benedict.benedict | None = None, persona=None, seed=None, crawl=None, snapshot=None, archiveresult=None, extra_config=None) 27 | :canonical: abx_spec_archivebox.reads.get_scope_config 28 | 29 | ```{autodoc2-docstring} abx_spec_archivebox.reads.get_scope_config 30 | ``` 31 | ```` 32 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.actors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.actors` 2 | 3 | ```{py:module} archivebox.actors 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.actors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.actors.models 17 | archivebox.actors.apps 18 | archivebox.actors.admin 19 | archivebox.actors.orchestrator 20 | archivebox.actors.actor 21 | archivebox.actors.views 22 | ``` 23 | 24 | ## Package Contents 25 | 26 | ### Data 27 | 28 | ````{list-table} 29 | :class: autosummary longtable 30 | :align: left 31 | 32 | * - {py:obj}`__order__ ` 33 | - ```{autodoc2-docstring} archivebox.actors.__order__ 34 | :summary: 35 | ``` 36 | ```` 37 | 38 | ### API 39 | 40 | ````{py:data} __order__ 41 | :canonical: archivebox.actors.__order__ 42 | :value: > 43 | 100 44 | 45 | ```{autodoc2-docstring} archivebox.actors.__order__ 46 | ``` 47 | 48 | ```` 49 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.apps` 2 | 3 | ```{py:module} archivebox.core.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`CoreConfig ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} CoreConfig(app_name, app_module) 25 | :canonical: archivebox.core.apps.CoreConfig 26 | 27 | Bases: {py:obj}`django.apps.AppConfig` 28 | 29 | ````{py:attribute} name 30 | :canonical: archivebox.core.apps.CoreConfig.name 31 | :value: > 32 | 'core' 33 | 34 | ```{autodoc2-docstring} archivebox.core.apps.CoreConfig.name 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:method} ready() 40 | :canonical: archivebox.core.apps.CoreConfig.ready 41 | 42 | ```{autodoc2-docstring} archivebox.core.apps.CoreConfig.ready 43 | ``` 44 | 45 | ```` 46 | 47 | ````` 48 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.config` 2 | 3 | ```{py:module} archivebox.config 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.config.django 17 | archivebox.config.version 18 | archivebox.config.paths 19 | archivebox.config.constants 20 | archivebox.config.common 21 | archivebox.config.collection 22 | archivebox.config.permissions 23 | archivebox.config.views 24 | ``` 25 | 26 | ## Package Contents 27 | 28 | ### Data 29 | 30 | ````{list-table} 31 | :class: autosummary longtable 32 | :align: left 33 | 34 | * - {py:obj}`__order__ ` 35 | - ```{autodoc2-docstring} archivebox.config.__order__ 36 | :summary: 37 | ``` 38 | ```` 39 | 40 | ### API 41 | 42 | ````{py:data} __order__ 43 | :canonical: archivebox.config.__order__ 44 | :value: > 45 | 200 46 | 47 | ```{autodoc2-docstring} archivebox.config.__order__ 48 | ``` 49 | 50 | ```` 51 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.search.admin.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.search.admin` 2 | 3 | ```{py:module} archivebox.search.admin 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.search.admin 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SearchResultsAdminMixin ` 19 | - ```{autodoc2-docstring} archivebox.search.admin.SearchResultsAdminMixin 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | `````{py:class} SearchResultsAdminMixin 27 | :canonical: archivebox.search.admin.SearchResultsAdminMixin 28 | 29 | ```{autodoc2-docstring} archivebox.search.admin.SearchResultsAdminMixin 30 | ``` 31 | 32 | ````{py:method} get_search_results(request, queryset, search_term: str) 33 | :canonical: archivebox.search.admin.SearchResultsAdminMixin.get_search_results 34 | 35 | ```{autodoc2-docstring} archivebox.search.admin.SearchResultsAdminMixin.get_search_results 36 | ``` 37 | 38 | ```` 39 | 40 | ````` 41 | -------------------------------------------------------------------------------- /Donations.md: -------------------------------------------------------------------------------- 1 | ## Supporting Development 2 | 3 | *ArchiveBox operates as a US 501(c)(3) nonprofit, donations are tax-deductible.* 4 | (ArchiveBox is fiscally sponsored by HCB EIN: 81-2908499) 5 |
6 | 7 | **💬 [Hire us](https://docs.sweeting.me/s/archivebox-consulting-services)** to help your NGO/org with archiving, or donate to directly support ArchiveBox open-source development. 8 | 9 | - ⭐️ **Direct donation via our `501(c)(3)` non-profit:** https://hcb.hackclub.com/donations/start/archivebox 10 | 11 | - ⭐️ **Github Sponsors:** https://github.com/sponsors/pirate 12 | 13 | - **Patreon:** https://www.patreon.com/theSquashSH 14 | 15 | - **Paypal:** https://paypal.me/NicholasSweeting 16 | 17 | - **Crypto:** *[Contact me to request wallet address...](https://zulip.archivebox.io/#narrow/dm/284-Nick-Sweeting)* 18 | 19 |
20 | 21 | If you have any questions or want to partner with this project, contact me at: `donations-hello` `@` `archivebox` `.` `io`. -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.seeds.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.seeds.apps` 2 | 3 | ```{py:module} archivebox.seeds.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.seeds.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SeedsConfig ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} SeedsConfig(app_name, app_module) 25 | :canonical: archivebox.seeds.apps.SeedsConfig 26 | 27 | Bases: {py:obj}`django.apps.AppConfig` 28 | 29 | ````{py:attribute} default_auto_field 30 | :canonical: archivebox.seeds.apps.SeedsConfig.default_auto_field 31 | :value: > 32 | 'django.db.models.BigAutoField' 33 | 34 | ```{autodoc2-docstring} archivebox.seeds.apps.SeedsConfig.default_auto_field 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:attribute} name 40 | :canonical: archivebox.seeds.apps.SeedsConfig.name 41 | :value: > 42 | 'seeds' 43 | 44 | ```{autodoc2-docstring} archivebox.seeds.apps.SeedsConfig.name 45 | ``` 46 | 47 | ```` 48 | 49 | ````` 50 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.actors.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.actors.apps` 2 | 3 | ```{py:module} archivebox.actors.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.actors.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ActorsConfig ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} ActorsConfig(app_name, app_module) 25 | :canonical: archivebox.actors.apps.ActorsConfig 26 | 27 | Bases: {py:obj}`django.apps.AppConfig` 28 | 29 | ````{py:attribute} default_auto_field 30 | :canonical: archivebox.actors.apps.ActorsConfig.default_auto_field 31 | :value: > 32 | 'django.db.models.BigAutoField' 33 | 34 | ```{autodoc2-docstring} archivebox.actors.apps.ActorsConfig.default_auto_field 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:attribute} name 40 | :canonical: archivebox.actors.apps.ActorsConfig.name 41 | :value: > 42 | 'actors' 43 | 44 | ```{autodoc2-docstring} archivebox.actors.apps.ActorsConfig.name 45 | ``` 46 | 47 | ```` 48 | 49 | ````` 50 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.crawls.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.crawls.apps` 2 | 3 | ```{py:module} archivebox.crawls.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.crawls.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`CrawlsConfig ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} CrawlsConfig(app_name, app_module) 25 | :canonical: archivebox.crawls.apps.CrawlsConfig 26 | 27 | Bases: {py:obj}`django.apps.AppConfig` 28 | 29 | ````{py:attribute} default_auto_field 30 | :canonical: archivebox.crawls.apps.CrawlsConfig.default_auto_field 31 | :value: > 32 | 'django.db.models.BigAutoField' 33 | 34 | ```{autodoc2-docstring} archivebox.crawls.apps.CrawlsConfig.default_auto_field 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:attribute} name 40 | :canonical: archivebox.crawls.apps.CrawlsConfig.name 41 | :value: > 42 | 'crawls' 43 | 44 | ```{autodoc2-docstring} archivebox.crawls.apps.CrawlsConfig.name 45 | ``` 46 | 47 | ```` 48 | 49 | ````` 50 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.asgi.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.asgi` 2 | 3 | ```{py:module} archivebox.core.asgi 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.asgi 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Data 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`django_asgi_app ` 19 | - ```{autodoc2-docstring} archivebox.core.asgi.django_asgi_app 20 | :summary: 21 | ``` 22 | * - {py:obj}`application ` 23 | - ```{autodoc2-docstring} archivebox.core.asgi.application 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### API 29 | 30 | ````{py:data} django_asgi_app 31 | :canonical: archivebox.core.asgi.django_asgi_app 32 | :value: > 33 | 'get_asgi_application(...)' 34 | 35 | ```{autodoc2-docstring} archivebox.core.asgi.django_asgi_app 36 | ``` 37 | 38 | ```` 39 | 40 | ````{py:data} application 41 | :canonical: archivebox.core.asgi.application 42 | :value: > 43 | 'ProtocolTypeRouter(...)' 44 | 45 | ```{autodoc2-docstring} archivebox.core.asgi.application 46 | ``` 47 | 48 | ```` 49 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_curl/abx_plugin_curl.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_curl` 2 | 3 | ```{py:module} abx_plugin_curl 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_curl 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_curl.config 17 | abx_plugin_curl.binaries 18 | abx_plugin_curl.headers 19 | ``` 20 | 21 | ## Package Contents 22 | 23 | ### Functions 24 | 25 | ````{list-table} 26 | :class: autosummary longtable 27 | :align: left 28 | 29 | * - {py:obj}`get_CONFIG ` 30 | - ```{autodoc2-docstring} abx_plugin_curl.get_CONFIG 31 | :summary: 32 | ``` 33 | * - {py:obj}`get_BINARIES ` 34 | - ```{autodoc2-docstring} abx_plugin_curl.get_BINARIES 35 | :summary: 36 | ``` 37 | ```` 38 | 39 | ### API 40 | 41 | ````{py:function} get_CONFIG() 42 | :canonical: abx_plugin_curl.get_CONFIG 43 | 44 | ```{autodoc2-docstring} abx_plugin_curl.get_CONFIG 45 | ``` 46 | ```` 47 | 48 | ````{py:function} get_BINARIES() 49 | :canonical: abx_plugin_curl.get_BINARIES 50 | 51 | ```{autodoc2-docstring} abx_plugin_curl.get_BINARIES 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.personas.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.personas.apps` 2 | 3 | ```{py:module} archivebox.personas.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.personas.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SessionsConfig ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} SessionsConfig(app_name, app_module) 25 | :canonical: archivebox.personas.apps.SessionsConfig 26 | 27 | Bases: {py:obj}`django.apps.AppConfig` 28 | 29 | ````{py:attribute} default_auto_field 30 | :canonical: archivebox.personas.apps.SessionsConfig.default_auto_field 31 | :value: > 32 | 'django.db.models.BigAutoField' 33 | 34 | ```{autodoc2-docstring} archivebox.personas.apps.SessionsConfig.default_auto_field 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:attribute} name 40 | :canonical: archivebox.personas.apps.SessionsConfig.name 41 | :value: > 42 | 'personas' 43 | 44 | ```{autodoc2-docstring} archivebox.personas.apps.SessionsConfig.name 45 | ``` 46 | 47 | ```` 48 | 49 | ````` 50 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.abid_utils.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.abid_utils.apps` 2 | 3 | ```{py:module} archivebox.abid_utils.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.abid_utils.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`AbidUtilsConfig ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} AbidUtilsConfig(app_name, app_module) 25 | :canonical: archivebox.abid_utils.apps.AbidUtilsConfig 26 | 27 | Bases: {py:obj}`django.apps.AppConfig` 28 | 29 | ````{py:attribute} default_auto_field 30 | :canonical: archivebox.abid_utils.apps.AbidUtilsConfig.default_auto_field 31 | :value: > 32 | 'django.db.models.BigAutoField' 33 | 34 | ```{autodoc2-docstring} archivebox.abid_utils.apps.AbidUtilsConfig.default_auto_field 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:attribute} name 40 | :canonical: archivebox.abid_utils.apps.AbidUtilsConfig.name 41 | :value: > 42 | 'abid_utils' 43 | 44 | ```{autodoc2-docstring} archivebox.abid_utils.apps.AbidUtilsConfig.name 45 | ``` 46 | 47 | ```` 48 | 49 | ````` 50 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.misc.paginators.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.misc.paginators` 2 | 3 | ```{py:module} archivebox.misc.paginators 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.misc.paginators 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`AccelleratedPaginator ` 19 | - ```{autodoc2-docstring} archivebox.misc.paginators.AccelleratedPaginator 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | `````{py:class} AccelleratedPaginator(object_list, per_page, orphans=0, allow_empty_first_page=True, error_messages=None) 27 | :canonical: archivebox.misc.paginators.AccelleratedPaginator 28 | 29 | Bases: {py:obj}`django.core.paginator.Paginator` 30 | 31 | ```{autodoc2-docstring} archivebox.misc.paginators.AccelleratedPaginator 32 | ``` 33 | 34 | ```{rubric} Initialization 35 | ``` 36 | 37 | ```{autodoc2-docstring} archivebox.misc.paginators.AccelleratedPaginator.__init__ 38 | ``` 39 | 40 | ````{py:method} count() 41 | :canonical: archivebox.misc.paginators.AccelleratedPaginator.count 42 | 43 | ```` 44 | 45 | ````` 46 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.index.csv.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.index.csv` 2 | 3 | ```{py:module} archivebox.index.csv 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.index.csv 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`links_to_csv ` 19 | - ```{autodoc2-docstring} archivebox.index.csv.links_to_csv 20 | :summary: 21 | ``` 22 | * - {py:obj}`to_csv ` 23 | - ```{autodoc2-docstring} archivebox.index.csv.to_csv 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### API 29 | 30 | ````{py:function} links_to_csv(links: typing.List[archivebox.index.schema.Link], cols: typing.Optional[typing.List[str]] = None, header: bool = True, separator: str = ',', ljust: int = 0) -> str 31 | :canonical: archivebox.index.csv.links_to_csv 32 | 33 | ```{autodoc2-docstring} archivebox.index.csv.links_to_csv 34 | ``` 35 | ```` 36 | 37 | ````{py:function} to_csv(obj: typing.Any, cols: typing.List[str], separator: str = ',', ljust: int = 0) -> str 38 | :canonical: archivebox.index.csv.to_csv 39 | 40 | ```{autodoc2-docstring} archivebox.index.csv.to_csv 41 | ``` 42 | ```` 43 | -------------------------------------------------------------------------------- /index.rst: -------------------------------------------------------------------------------- 1 | .. sidebar:: Welcome to ArchiveBox! 2 | 3 | Just getting started? 4 | Check out the `Quickstart `_ guide. 5 | Need help with something? 6 | Ping us on `Twitter `_ or `Github `_. 7 | Want to join the community? 8 | See our `Community Wiki `_ page. 9 | 10 | .. image:: logo.png 11 | :width: 200px 12 | :align: center 13 | :alt: ArchiveBox Logo 14 | 15 | ========== 16 | ArchiveBox 17 | ========== 18 | 19 | "The open-source self-hosted internet archive." 20 | 21 | `Website `_ | `Github `_ | `Source `_ | `Bug Tracker `_ 22 | 23 | .. code-block:: bash 24 | 25 | mkdir my-archive; cd my-archive/ 26 | pip install archivebox 27 | 28 | archivebox init 29 | archivebox add https://example.com 30 | archivebox info 31 | 32 | 33 | ============= 34 | Documentation 35 | ============= 36 | 37 | .. toctree:: 38 | :maxdepth: 2 39 | 40 | Contents.rst 41 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_wget/abx_plugin_wget.wget_util.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_wget.wget_util` 2 | 3 | ```{py:module} abx_plugin_wget.wget_util 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_wget.wget_util 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`unsafe_wget_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_wget.wget_util.unsafe_wget_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`wget_output_path ` 23 | - ```{autodoc2-docstring} abx_plugin_wget.wget_util.wget_output_path 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### API 29 | 30 | ````{py:function} unsafe_wget_output_path(link) -> typing.Optional[str] 31 | :canonical: abx_plugin_wget.wget_util.unsafe_wget_output_path 32 | 33 | ```{autodoc2-docstring} abx_plugin_wget.wget_util.unsafe_wget_output_path 34 | ``` 35 | ```` 36 | 37 | ````{py:function} wget_output_path(link, nocache: bool = False) -> typing.Optional[str] 38 | :canonical: abx_plugin_wget.wget_util.wget_output_path 39 | 40 | ```{autodoc2-docstring} abx_plugin_wget.wget_util.wget_output_path 41 | ``` 42 | ```` 43 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.api.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.api.apps` 2 | 3 | ```{py:module} archivebox.api.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.api.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`APIConfig ` 19 | - 20 | ```` 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`register_admin ` 29 | - ```{autodoc2-docstring} archivebox.api.apps.register_admin 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} APIConfig(app_name, app_module) 37 | :canonical: archivebox.api.apps.APIConfig 38 | 39 | Bases: {py:obj}`django.apps.AppConfig` 40 | 41 | ````{py:attribute} name 42 | :canonical: archivebox.api.apps.APIConfig.name 43 | :value: > 44 | 'api' 45 | 46 | ```{autodoc2-docstring} archivebox.api.apps.APIConfig.name 47 | ``` 48 | 49 | ```` 50 | 51 | ````` 52 | 53 | ````{py:function} register_admin(admin_site) 54 | :canonical: archivebox.api.apps.register_admin 55 | 56 | ```{autodoc2-docstring} archivebox.api.apps.register_admin 57 | ``` 58 | ```` 59 | -------------------------------------------------------------------------------- /apidocs/abx_spec_archivebox/abx_spec_archivebox.effects.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_spec_archivebox.effects` 2 | 3 | ```{py:module} abx_spec_archivebox.effects 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_spec_archivebox.effects 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`check_remote_seed_connection ` 19 | - ```{autodoc2-docstring} abx_spec_archivebox.effects.check_remote_seed_connection 20 | :summary: 21 | ``` 22 | * - {py:obj}`exec_extractor ` 23 | - ```{autodoc2-docstring} abx_spec_archivebox.effects.exec_extractor 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### API 29 | 30 | ````{py:function} check_remote_seed_connection(urls, extractor, credentials, created_by) 31 | :canonical: abx_spec_archivebox.effects.check_remote_seed_connection 32 | 33 | ```{autodoc2-docstring} abx_spec_archivebox.effects.check_remote_seed_connection 34 | ``` 35 | ```` 36 | 37 | ````{py:function} exec_extractor(url, extractor, credentials, config) 38 | :canonical: abx_spec_archivebox.effects.exec_extractor 39 | 40 | ```{autodoc2-docstring} abx_spec_archivebox.effects.exec_extractor 41 | ``` 42 | ```` 43 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.misc.shell_welcome_message.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.misc.shell_welcome_message` 2 | 3 | ```{py:module} archivebox.misc.shell_welcome_message 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.misc.shell_welcome_message 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Data 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`CONFIG ` 19 | - ```{autodoc2-docstring} archivebox.misc.shell_welcome_message.CONFIG 20 | :summary: 21 | ``` 22 | * - {py:obj}`CLI_COMMAND_NAMES ` 23 | - ```{autodoc2-docstring} archivebox.misc.shell_welcome_message.CLI_COMMAND_NAMES 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### API 29 | 30 | ````{py:data} CONFIG 31 | :canonical: archivebox.misc.shell_welcome_message.CONFIG 32 | :value: > 33 | 'get_FLAT_CONFIG(...)' 34 | 35 | ```{autodoc2-docstring} archivebox.misc.shell_welcome_message.CONFIG 36 | ``` 37 | 38 | ```` 39 | 40 | ````{py:data} CLI_COMMAND_NAMES 41 | :canonical: archivebox.misc.shell_welcome_message.CLI_COMMAND_NAMES 42 | :value: > 43 | 'join(...)' 44 | 45 | ```{autodoc2-docstring} archivebox.misc.shell_welcome_message.CLI_COMMAND_NAMES 46 | ``` 47 | 48 | ```` 49 | -------------------------------------------------------------------------------- /Contents.rst: -------------------------------------------------------------------------------- 1 | Contents 2 | ######## 3 | 4 | Overview 5 | ######## 6 | 7 | .. toctree:: 8 | :maxdepth: 1 9 | 10 | README.md 11 | 12 | 13 | Getting Started 14 | ############### 15 | 16 | .. toctree:: 17 | :maxdepth: 1 18 | 19 | Quickstart.md 20 | Install.md 21 | Docker.md 22 | Configuration.md 23 | Security-Overview.md 24 | 25 | .. toctree:: 26 | :maxdepth: 2 27 | 28 | Usage.md 29 | 30 | Guides 31 | ###### 32 | 33 | .. toctree:: 34 | :maxdepth: 1 35 | 36 | Setting-Up-Storage.md 37 | Setting-up-Authentication.md 38 | Setting-up-Search.md 39 | Publishing-Your-Archive.md 40 | Scheduled-Archiving.md 41 | Chromium-Install.md 42 | Upgrading.md 43 | Merging-Collections.md 44 | Troubleshooting.md 45 | 46 | 47 | API Reference 48 | ############# 49 | 50 | .. toctree:: 51 | :maxdepth: 3 52 | 53 | Filesystem 54 | SQL API 55 | REST API 56 | Python API 57 | 58 | Meta 59 | #### 60 | 61 | .. toctree:: 62 | :maxdepth: 1 63 | 64 | Roadmap.md 65 | Changelog.md 66 | Donations.md 67 | 68 | 69 | .. toctree:: 70 | :maxdepth: 3 71 | 72 | Web-Archiving-Community.md 73 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.seeds.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.seeds` 2 | 3 | ```{py:module} archivebox.seeds 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.seeds 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.seeds.models 17 | archivebox.seeds.apps 18 | archivebox.seeds.admin 19 | archivebox.seeds.views 20 | ``` 21 | 22 | ## Package Contents 23 | 24 | ### Functions 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`register_admin ` 31 | - ```{autodoc2-docstring} archivebox.seeds.register_admin 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### Data 37 | 38 | ````{list-table} 39 | :class: autosummary longtable 40 | :align: left 41 | 42 | * - {py:obj}`__order__ ` 43 | - ```{autodoc2-docstring} archivebox.seeds.__order__ 44 | :summary: 45 | ``` 46 | ```` 47 | 48 | ### API 49 | 50 | ````{py:data} __order__ 51 | :canonical: archivebox.seeds.__order__ 52 | :value: > 53 | 100 54 | 55 | ```{autodoc2-docstring} archivebox.seeds.__order__ 56 | ``` 57 | 58 | ```` 59 | 60 | ````{py:function} register_admin(admin_site) 61 | :canonical: archivebox.seeds.register_admin 62 | 63 | ```{autodoc2-docstring} archivebox.seeds.register_admin 64 | ``` 65 | ```` 66 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_htmltotext/abx_plugin_htmltotext.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_htmltotext` 2 | 3 | ```{py:module} abx_plugin_htmltotext 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_htmltotext 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_htmltotext.htmltotext 17 | abx_plugin_htmltotext.config 18 | ``` 19 | 20 | ## Package Contents 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`get_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_htmltotext.get_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### Data 35 | 36 | ````{list-table} 37 | :class: autosummary longtable 38 | :align: left 39 | 40 | * - {py:obj}`__label__ ` 41 | - ```{autodoc2-docstring} abx_plugin_htmltotext.__label__ 42 | :summary: 43 | ``` 44 | ```` 45 | 46 | ### API 47 | 48 | ````{py:data} __label__ 49 | :canonical: abx_plugin_htmltotext.__label__ 50 | :value: > 51 | 'HTML-to-Text' 52 | 53 | ```{autodoc2-docstring} abx_plugin_htmltotext.__label__ 54 | ``` 55 | 56 | ```` 57 | 58 | ````{py:function} get_CONFIG() 59 | :canonical: abx_plugin_htmltotext.get_CONFIG 60 | 61 | ```{autodoc2-docstring} abx_plugin_htmltotext.get_CONFIG 62 | ``` 63 | ```` 64 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_help.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_help` 2 | 3 | ```{py:module} archivebox.cli.archivebox_help 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_help 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_help.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_help.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_help.__command__ 40 | :value: > 41 | 'archivebox help' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_help.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_help.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_help.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_init.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_init` 2 | 3 | ```{py:module} archivebox.cli.archivebox_init 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_init 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_init.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_init.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_init.__command__ 40 | :value: > 41 | 'archivebox init' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_init.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_init.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_init.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_list.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_list` 2 | 3 | ```{py:module} archivebox.cli.archivebox_list 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_list 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_list.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_list.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_list.__command__ 40 | :value: > 41 | 'archivebox list' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_list.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_list.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_list.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_shell.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_shell` 2 | 3 | ```{py:module} archivebox.cli.archivebox_shell 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_shell 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_shell.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_shell.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_shell.__command__ 40 | :value: > 41 | 'archivebox shell' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_shell.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_shell.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_shell.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_config` 2 | 3 | ```{py:module} archivebox.cli.archivebox_config 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_config.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_config.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_config.__command__ 40 | :value: > 41 | 'archivebox config' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_config.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_config.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_config.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_manage.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_manage` 2 | 3 | ```{py:module} archivebox.cli.archivebox_manage 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_manage 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_manage.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_manage.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_manage.__command__ 40 | :value: > 41 | 'archivebox manage' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_manage.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_manage.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_manage.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_remove.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_remove` 2 | 3 | ```{py:module} archivebox.cli.archivebox_remove 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_remove 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_remove.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_remove.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_remove.__command__ 40 | :value: > 41 | 'archivebox remove' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_remove.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_remove.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_remove.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_server.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_server` 2 | 3 | ```{py:module} archivebox.cli.archivebox_server 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_server 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_server.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_server.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_server.__command__ 40 | :value: > 41 | 'archivebox server' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_server.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_server.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_server.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_status.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_status` 2 | 3 | ```{py:module} archivebox.cli.archivebox_status 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_status 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_status.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_status.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_status.__command__ 40 | :value: > 41 | 'archivebox status' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_status.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_status.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_status.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_install.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_install` 2 | 3 | ```{py:module} archivebox.cli.archivebox_install 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_install 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_install.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_install.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_install.__command__ 40 | :value: > 41 | 'archivebox install' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_install.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_install.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_install.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_oneshot.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_oneshot` 2 | 3 | ```{py:module} archivebox.cli.archivebox_oneshot 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_oneshot 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_oneshot.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_oneshot.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_oneshot.__command__ 40 | :value: > 41 | 'archivebox oneshot' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_oneshot.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_oneshot.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_oneshot.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_version.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_version` 2 | 3 | ```{py:module} archivebox.cli.archivebox_version 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_version 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_version.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_version.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_version.__command__ 40 | :value: > 41 | 'archivebox version' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_version.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_version.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_version.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.crawls.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.crawls` 2 | 3 | ```{py:module} archivebox.crawls 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.crawls 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | archivebox.crawls.models 17 | archivebox.crawls.apps 18 | archivebox.crawls.admin 19 | archivebox.crawls.statemachines 20 | archivebox.crawls.actors 21 | archivebox.crawls.views 22 | ``` 23 | 24 | ## Package Contents 25 | 26 | ### Functions 27 | 28 | ````{list-table} 29 | :class: autosummary longtable 30 | :align: left 31 | 32 | * - {py:obj}`register_admin ` 33 | - ```{autodoc2-docstring} archivebox.crawls.register_admin 34 | :summary: 35 | ``` 36 | ```` 37 | 38 | ### Data 39 | 40 | ````{list-table} 41 | :class: autosummary longtable 42 | :align: left 43 | 44 | * - {py:obj}`__order__ ` 45 | - ```{autodoc2-docstring} archivebox.crawls.__order__ 46 | :summary: 47 | ``` 48 | ```` 49 | 50 | ### API 51 | 52 | ````{py:data} __order__ 53 | :canonical: archivebox.crawls.__order__ 54 | :value: > 55 | 100 56 | 57 | ```{autodoc2-docstring} archivebox.crawls.__order__ 58 | ``` 59 | 60 | ```` 61 | 62 | ````{py:function} register_admin(admin_site) 63 | :canonical: archivebox.crawls.register_admin 64 | 65 | ```{autodoc2-docstring} archivebox.crawls.register_admin 66 | ``` 67 | ```` 68 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.actors.views.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.actors.views` 2 | 3 | ```{py:module} archivebox.actors.views 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.actors.views 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`JobsDashboardView ` 19 | - 20 | ```` 21 | 22 | ### API 23 | 24 | `````{py:class} JobsDashboardView(**kwargs) 25 | :canonical: archivebox.actors.views.JobsDashboardView 26 | 27 | Bases: {py:obj}`django.contrib.auth.mixins.UserPassesTestMixin`, {py:obj}`django.views.generic.TemplateView` 28 | 29 | ````{py:attribute} template_name 30 | :canonical: archivebox.actors.views.JobsDashboardView.template_name 31 | :value: > 32 | 'jobs_dashboard.html' 33 | 34 | ```{autodoc2-docstring} archivebox.actors.views.JobsDashboardView.template_name 35 | ``` 36 | 37 | ```` 38 | 39 | ````{py:method} test_func() 40 | :canonical: archivebox.actors.views.JobsDashboardView.test_func 41 | 42 | ```{autodoc2-docstring} archivebox.actors.views.JobsDashboardView.test_func 43 | ``` 44 | 45 | ```` 46 | 47 | ````{py:method} get_context_data(**kwargs) 48 | :canonical: archivebox.actors.views.JobsDashboardView.get_context_data 49 | 50 | ```{autodoc2-docstring} archivebox.actors.views.JobsDashboardView.get_context_data 51 | ``` 52 | 53 | ```` 54 | 55 | ````` 56 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_schedule.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_schedule` 2 | 3 | ```{py:module} archivebox.cli.archivebox_schedule 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_schedule 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`main ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_schedule.main 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__command__ ` 31 | - ```{autodoc2-docstring} archivebox.cli.archivebox_schedule.__command__ 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} __command__ 39 | :canonical: archivebox.cli.archivebox_schedule.__command__ 40 | :value: > 41 | 'archivebox schedule' 42 | 43 | ```{autodoc2-docstring} archivebox.cli.archivebox_schedule.__command__ 44 | ``` 45 | 46 | ```` 47 | 48 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 49 | :canonical: archivebox.cli.archivebox_schedule.main 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_schedule.main 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.pkgs.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.pkgs` 2 | 3 | ```{py:module} archivebox.pkgs 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.pkgs 7 | :allowtitles: 8 | ``` 9 | 10 | ## Package Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`load_vendored_pkgs ` 19 | - ```{autodoc2-docstring} archivebox.pkgs.load_vendored_pkgs 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`PKGS_DIR ` 31 | - ```{autodoc2-docstring} archivebox.pkgs.PKGS_DIR 32 | :summary: 33 | ``` 34 | * - {py:obj}`VENDORED_PKGS ` 35 | - ```{autodoc2-docstring} archivebox.pkgs.VENDORED_PKGS 36 | :summary: 37 | ``` 38 | ```` 39 | 40 | ### API 41 | 42 | ````{py:data} PKGS_DIR 43 | :canonical: archivebox.pkgs.PKGS_DIR 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} archivebox.pkgs.PKGS_DIR 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:data} VENDORED_PKGS 53 | :canonical: archivebox.pkgs.VENDORED_PKGS 54 | :value: > 55 | ['abx'] 56 | 57 | ```{autodoc2-docstring} archivebox.pkgs.VENDORED_PKGS 58 | ``` 59 | 60 | ```` 61 | 62 | ````{py:function} load_vendored_pkgs() 63 | :canonical: archivebox.pkgs.load_vendored_pkgs 64 | 65 | ```{autodoc2-docstring} archivebox.pkgs.load_vendored_pkgs 66 | ``` 67 | ```` 68 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_pocket/abx_plugin_pocket.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_pocket` 2 | 3 | ```{py:module} abx_plugin_pocket 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_pocket 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_pocket.config 17 | ``` 18 | 19 | ## Package Contents 20 | 21 | ### Functions 22 | 23 | ````{list-table} 24 | :class: autosummary longtable 25 | :align: left 26 | 27 | * - {py:obj}`get_CONFIG ` 28 | - ```{autodoc2-docstring} abx_plugin_pocket.get_CONFIG 29 | :summary: 30 | ``` 31 | * - {py:obj}`ready ` 32 | - ```{autodoc2-docstring} abx_plugin_pocket.ready 33 | :summary: 34 | ``` 35 | ```` 36 | 37 | ### Data 38 | 39 | ````{list-table} 40 | :class: autosummary longtable 41 | :align: left 42 | 43 | * - {py:obj}`__label__ ` 44 | - ```{autodoc2-docstring} abx_plugin_pocket.__label__ 45 | :summary: 46 | ``` 47 | ```` 48 | 49 | ### API 50 | 51 | ````{py:data} __label__ 52 | :canonical: abx_plugin_pocket.__label__ 53 | :value: > 54 | 'Pocket' 55 | 56 | ```{autodoc2-docstring} abx_plugin_pocket.__label__ 57 | ``` 58 | 59 | ```` 60 | 61 | ````{py:function} get_CONFIG() 62 | :canonical: abx_plugin_pocket.get_CONFIG 63 | 64 | ```{autodoc2-docstring} abx_plugin_pocket.get_CONFIG 65 | ``` 66 | ```` 67 | 68 | ````{py:function} ready() 69 | :canonical: abx_plugin_pocket.ready 70 | 71 | ```{autodoc2-docstring} abx_plugin_pocket.ready 72 | ``` 73 | ```` 74 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.queues.admin.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.queues.admin` 2 | 3 | ```{py:module} archivebox.queues.admin 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.queues.admin 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`CustomTaskModelAdmin ` 19 | - 20 | ```` 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`register_admin ` 29 | - ```{autodoc2-docstring} archivebox.queues.admin.register_admin 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} CustomTaskModelAdmin(model, admin_site) 37 | :canonical: archivebox.queues.admin.CustomTaskModelAdmin 38 | 39 | Bases: {py:obj}`huey_monitor.admin.TaskModelAdmin` 40 | 41 | ````{py:attribute} actions 42 | :canonical: archivebox.queues.admin.CustomTaskModelAdmin.actions 43 | :value: > 44 | ['delete_selected'] 45 | 46 | ```{autodoc2-docstring} archivebox.queues.admin.CustomTaskModelAdmin.actions 47 | ``` 48 | 49 | ```` 50 | 51 | ````{py:method} has_delete_permission(request, obj=None) 52 | :canonical: archivebox.queues.admin.CustomTaskModelAdmin.has_delete_permission 53 | 54 | ```` 55 | 56 | ````` 57 | 58 | ````{py:function} register_admin(admin_site) 59 | :canonical: archivebox.queues.admin.register_admin 60 | 61 | ```{autodoc2-docstring} archivebox.queues.admin.register_admin 62 | ``` 63 | ```` 64 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.queues.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.queues.apps` 2 | 3 | ```{py:module} archivebox.queues.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.queues.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`QueuesConfig ` 19 | - 20 | ```` 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`register_admin ` 29 | - ```{autodoc2-docstring} archivebox.queues.apps.register_admin 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} QueuesConfig(app_name, app_module) 37 | :canonical: archivebox.queues.apps.QueuesConfig 38 | 39 | Bases: {py:obj}`django.apps.AppConfig` 40 | 41 | ````{py:attribute} default_auto_field 42 | :canonical: archivebox.queues.apps.QueuesConfig.default_auto_field 43 | :value: > 44 | 'django.db.models.BigAutoField' 45 | 46 | ```{autodoc2-docstring} archivebox.queues.apps.QueuesConfig.default_auto_field 47 | ``` 48 | 49 | ```` 50 | 51 | ````{py:attribute} name 52 | :canonical: archivebox.queues.apps.QueuesConfig.name 53 | :value: > 54 | 'queues' 55 | 56 | ```{autodoc2-docstring} archivebox.queues.apps.QueuesConfig.name 57 | ``` 58 | 59 | ```` 60 | 61 | ````` 62 | 63 | ````{py:function} register_admin(admin_site) 64 | :canonical: archivebox.queues.apps.register_admin 65 | 66 | ```{autodoc2-docstring} archivebox.queues.apps.register_admin 67 | ``` 68 | ```` 69 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_title/abx_plugin_title.extractors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_title.extractors` 2 | 3 | ```{py:module} abx_plugin_title.extractors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_title.extractors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`TitleExtractor ` 19 | - ```{autodoc2-docstring} abx_plugin_title.extractors.TitleExtractor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`TITLE_EXTRACTOR ` 31 | - ```{autodoc2-docstring} abx_plugin_title.extractors.TITLE_EXTRACTOR 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | `````{py:class} TitleExtractor 39 | :canonical: abx_plugin_title.extractors.TitleExtractor 40 | 41 | Bases: {py:obj}`abx_spec_extractor.BaseExtractor` 42 | 43 | ```{autodoc2-docstring} abx_plugin_title.extractors.TitleExtractor 44 | ``` 45 | 46 | ````{py:attribute} name 47 | :canonical: abx_plugin_title.extractors.TitleExtractor.name 48 | :type: abx_spec_extractor.ExtractorName 49 | :value: > 50 | 'title' 51 | 52 | ```{autodoc2-docstring} abx_plugin_title.extractors.TitleExtractor.name 53 | ``` 54 | 55 | ```` 56 | 57 | ````` 58 | 59 | ````{py:data} TITLE_EXTRACTOR 60 | :canonical: abx_plugin_title.extractors.TITLE_EXTRACTOR 61 | :value: > 62 | 'TitleExtractor(...)' 63 | 64 | ```{autodoc2-docstring} abx_plugin_title.extractors.TITLE_EXTRACTOR 65 | ``` 66 | 67 | ```` 68 | -------------------------------------------------------------------------------- /apidocs/index.rst: -------------------------------------------------------------------------------- 1 | API Reference 2 | ============= 3 | 4 | This page contains auto-generated API reference documentation [#f1]_. 5 | 6 | .. toctree:: 7 | :titlesonly: 8 | 9 | archivebox/archivebox 10 | abx_plugin_ldap_auth/abx_plugin_ldap_auth 11 | abx/abx 12 | abx_spec_archivebox/abx_spec_archivebox 13 | abx_plugin_sqlitefts_search/abx_plugin_sqlitefts_search 14 | abx_spec_django/abx_spec_django 15 | abx_plugin_default_binproviders/abx_plugin_default_binproviders 16 | abx_plugin_sonic_search/abx_plugin_sonic_search 17 | abx_spec_abx_pkg/abx_spec_abx_pkg 18 | abx_plugin_chrome/abx_plugin_chrome 19 | abx_spec_searchbackend/abx_spec_searchbackend 20 | abx_plugin_singlefile/abx_plugin_singlefile 21 | abx_plugin_wget/abx_plugin_wget 22 | abx_plugin_ripgrep_search/abx_plugin_ripgrep_search 23 | abx_plugin_readwise/abx_plugin_readwise 24 | abx_spec_extractor/abx_spec_extractor 25 | abx_plugin_pip/abx_plugin_pip 26 | abx_plugin_htmltotext/abx_plugin_htmltotext 27 | abx_plugin_ytdlp/abx_plugin_ytdlp 28 | abx_plugin_readability/abx_plugin_readability 29 | abx_plugin_playwright/abx_plugin_playwright 30 | abx_plugin_favicon/abx_plugin_favicon 31 | abx_plugin_mercury/abx_plugin_mercury 32 | abx_plugin_archivedotorg/abx_plugin_archivedotorg 33 | abx_plugin_puppeteer/abx_plugin_puppeteer 34 | abx_plugin_npm/abx_plugin_npm 35 | abx_plugin_pocket/abx_plugin_pocket 36 | abx_plugin_title/abx_plugin_title 37 | abx_plugin_curl/abx_plugin_curl 38 | abx_plugin_git/abx_plugin_git 39 | abx_spec_config/abx_spec_config 40 | 41 | .. [#f1] Created with `sphinx-autodoc2 `_ 42 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_git/abx_plugin_git.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_git.binaries` 2 | 3 | ```{py:module} abx_plugin_git.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_git.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`GitBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`GIT_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_git.binaries.GIT_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} GitBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_git.binaries.GitBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_git.binaries.GitBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_git.binaries.GitBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_git.binaries.GitBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_git.binaries.GitBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````` 64 | 65 | ````{py:data} GIT_BINARY 66 | :canonical: abx_plugin_git.binaries.GIT_BINARY 67 | :value: > 68 | 'GitBinary(...)' 69 | 70 | ```{autodoc2-docstring} abx_plugin_git.binaries.GIT_BINARY 71 | ``` 72 | 73 | ```` 74 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_chrome/abx_plugin_chrome.dom.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_chrome.dom` 2 | 3 | ```{py:module} abx_plugin_chrome.dom 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_chrome.dom 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_chrome.dom.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`should_save_dom ` 23 | - ```{autodoc2-docstring} abx_plugin_chrome.dom.should_save_dom 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_dom ` 27 | - ```{autodoc2-docstring} abx_plugin_chrome.dom.save_dom 28 | :summary: 29 | ``` 30 | ```` 31 | 32 | ### API 33 | 34 | ````{py:function} get_output_path() 35 | :canonical: abx_plugin_chrome.dom.get_output_path 36 | 37 | ```{autodoc2-docstring} abx_plugin_chrome.dom.get_output_path 38 | ``` 39 | ```` 40 | 41 | ````{py:function} should_save_dom(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 42 | :canonical: abx_plugin_chrome.dom.should_save_dom 43 | 44 | ```{autodoc2-docstring} abx_plugin_chrome.dom.should_save_dom 45 | ``` 46 | ```` 47 | 48 | ````{py:function} save_dom(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = 60) -> archivebox.index.schema.ArchiveResult 49 | :canonical: abx_plugin_chrome.dom.save_dom 50 | 51 | ```{autodoc2-docstring} abx_plugin_chrome.dom.save_dom 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_chrome/abx_plugin_chrome.pdf.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_chrome.pdf` 2 | 3 | ```{py:module} abx_plugin_chrome.pdf 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_chrome.pdf 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_chrome.pdf.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`should_save_pdf ` 23 | - ```{autodoc2-docstring} abx_plugin_chrome.pdf.should_save_pdf 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_pdf ` 27 | - ```{autodoc2-docstring} abx_plugin_chrome.pdf.save_pdf 28 | :summary: 29 | ``` 30 | ```` 31 | 32 | ### API 33 | 34 | ````{py:function} get_output_path() 35 | :canonical: abx_plugin_chrome.pdf.get_output_path 36 | 37 | ```{autodoc2-docstring} abx_plugin_chrome.pdf.get_output_path 38 | ``` 39 | ```` 40 | 41 | ````{py:function} should_save_pdf(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 42 | :canonical: abx_plugin_chrome.pdf.should_save_pdf 43 | 44 | ```{autodoc2-docstring} abx_plugin_chrome.pdf.should_save_pdf 45 | ``` 46 | ```` 47 | 48 | ````{py:function} save_pdf(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = 60) -> archivebox.index.schema.ArchiveResult 49 | :canonical: abx_plugin_chrome.pdf.save_pdf 50 | 51 | ```{autodoc2-docstring} abx_plugin_chrome.pdf.save_pdf 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_curl/abx_plugin_curl.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_curl.binaries` 2 | 3 | ```{py:module} abx_plugin_curl.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_curl.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`CurlBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`CURL_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_curl.binaries.CURL_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} CurlBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_curl.binaries.CurlBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_curl.binaries.CurlBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_curl.binaries.CurlBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_curl.binaries.CurlBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_curl.binaries.CurlBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````` 64 | 65 | ````{py:data} CURL_BINARY 66 | :canonical: abx_plugin_curl.binaries.CURL_BINARY 67 | :value: > 68 | 'CurlBinary(...)' 69 | 70 | ```{autodoc2-docstring} abx_plugin_curl.binaries.CURL_BINARY 71 | ``` 72 | 73 | ```` 74 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_wget/abx_plugin_wget.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_wget.binaries` 2 | 3 | ```{py:module} abx_plugin_wget.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_wget.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`WgetBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`WGET_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_wget.binaries.WGET_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} WgetBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_wget.binaries.WgetBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_wget.binaries.WgetBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_wget.binaries.WgetBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_wget.binaries.WgetBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_wget.binaries.WgetBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````` 64 | 65 | ````{py:data} WGET_BINARY 66 | :canonical: abx_plugin_wget.binaries.WGET_BINARY 67 | :value: > 68 | 'WgetBinary(...)' 69 | 70 | ```{autodoc2-docstring} abx_plugin_wget.binaries.WGET_BINARY 71 | ``` 72 | 73 | ```` 74 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.monkey_patches.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.monkey_patches` 2 | 3 | ```{py:module} archivebox.monkey_patches 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.monkey_patches 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ModifiedAccessLogGenerator ` 19 | - ```{autodoc2-docstring} archivebox.monkey_patches.ModifiedAccessLogGenerator 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`TERM_WIDTH ` 31 | - ```{autodoc2-docstring} archivebox.monkey_patches.TERM_WIDTH 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:data} TERM_WIDTH 39 | :canonical: archivebox.monkey_patches.TERM_WIDTH 40 | :value: > 41 | None 42 | 43 | ```{autodoc2-docstring} archivebox.monkey_patches.TERM_WIDTH 44 | ``` 45 | 46 | ```` 47 | 48 | `````{py:class} ModifiedAccessLogGenerator(stream) 49 | :canonical: archivebox.monkey_patches.ModifiedAccessLogGenerator 50 | 51 | Bases: {py:obj}`daphne.access.AccessLogGenerator` 52 | 53 | ```{autodoc2-docstring} archivebox.monkey_patches.ModifiedAccessLogGenerator 54 | ``` 55 | 56 | ```{rubric} Initialization 57 | ``` 58 | 59 | ```{autodoc2-docstring} archivebox.monkey_patches.ModifiedAccessLogGenerator.__init__ 60 | ``` 61 | 62 | ````{py:method} write_entry(host, date, request, status=None, length=None, ident=None, user=None) 63 | :canonical: archivebox.monkey_patches.ModifiedAccessLogGenerator.write_entry 64 | 65 | ```` 66 | 67 | ````` 68 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_curl/abx_plugin_curl.headers.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_curl.headers` 2 | 3 | ```{py:module} abx_plugin_curl.headers 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_curl.headers 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_curl.headers.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`should_save_headers ` 23 | - ```{autodoc2-docstring} abx_plugin_curl.headers.should_save_headers 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_headers ` 27 | - ```{autodoc2-docstring} abx_plugin_curl.headers.save_headers 28 | :summary: 29 | ``` 30 | ```` 31 | 32 | ### API 33 | 34 | ````{py:function} get_output_path() 35 | :canonical: abx_plugin_curl.headers.get_output_path 36 | 37 | ```{autodoc2-docstring} abx_plugin_curl.headers.get_output_path 38 | ``` 39 | ```` 40 | 41 | ````{py:function} should_save_headers(link: archivebox.index.schema.Link, out_dir: typing.Optional[str] = None, overwrite: typing.Optional[bool] = False) -> bool 42 | :canonical: abx_plugin_curl.headers.should_save_headers 43 | 44 | ```{autodoc2-docstring} abx_plugin_curl.headers.should_save_headers 45 | ``` 46 | ```` 47 | 48 | ````{py:function} save_headers(link: archivebox.index.schema.Link, out_dir: typing.Optional[str] = None, timeout: int = CURL_CONFIG.CURL_TIMEOUT) -> archivebox.index.schema.ArchiveResult 49 | :canonical: abx_plugin_curl.headers.save_headers 50 | 51 | ```{autodoc2-docstring} abx_plugin_curl.headers.save_headers 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_update.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_update` 2 | 3 | ```{py:module} archivebox.cli.archivebox_update 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_update 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`update ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_update.update 20 | :summary: 21 | ``` 22 | * - {py:obj}`main ` 23 | - ```{autodoc2-docstring} archivebox.cli.archivebox_update.main 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### Data 29 | 30 | ````{list-table} 31 | :class: autosummary longtable 32 | :align: left 33 | 34 | * - {py:obj}`__command__ ` 35 | - ```{autodoc2-docstring} archivebox.cli.archivebox_update.__command__ 36 | :summary: 37 | ``` 38 | ```` 39 | 40 | ### API 41 | 42 | ````{py:data} __command__ 43 | :canonical: archivebox.cli.archivebox_update.__command__ 44 | :value: > 45 | 'archivebox update' 46 | 47 | ```{autodoc2-docstring} archivebox.cli.archivebox_update.__command__ 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:function} update() 53 | :canonical: archivebox.cli.archivebox_update.update 54 | 55 | ```{autodoc2-docstring} archivebox.cli.archivebox_update.update 56 | ``` 57 | ```` 58 | 59 | ````{py:function} main(args: typing.Optional[typing.List[str]] = None, stdin: typing.Optional[typing.IO] = None, pwd: typing.Optional[str] = None) -> None 60 | :canonical: archivebox.cli.archivebox_update.main 61 | 62 | ```{autodoc2-docstring} archivebox.cli.archivebox_update.main 63 | ``` 64 | ```` 65 | -------------------------------------------------------------------------------- /.mkdocs.unused/gen_docs_refs.py: -------------------------------------------------------------------------------- 1 | """Generate the code reference pages and navigation.""" 2 | 3 | from pathlib import Path 4 | 5 | import mkdocs_gen_files 6 | 7 | nav = mkdocs_gen_files.Nav() 8 | mod_symbol = '' 9 | 10 | packages_dir = Path(__file__).parent 11 | doc_root = packages_dir / 'docs' 12 | 13 | for path in sorted((packages_dir / 'archivebox').rglob("*.py")): 14 | module_path = path.relative_to(packages_dir).with_suffix("") 15 | doc_path = path.relative_to(packages_dir).with_suffix(".md") 16 | full_doc_path = doc_root / 'reference' / doc_path 17 | 18 | if "management" in str(module_path) or "vendor" in str(module_path) or 'machine' in str(module_path) or 'migrations' in str(module_path) or 'plugins' in str(module_path): 19 | continue 20 | 21 | parts = tuple(module_path.parts) 22 | 23 | 24 | if parts[-1] == "__init__": 25 | parts = parts[:-1] 26 | doc_path = doc_path.with_name("index.md") 27 | full_doc_path = full_doc_path.with_name("index.md") 28 | elif parts[-1].startswith("_"): 29 | continue 30 | 31 | full_doc_path = full_doc_path.relative_to(packages_dir) 32 | 33 | # import ipdb; ipdb.set_trace() 34 | 35 | nav_parts = [f"{mod_symbol} {part}" for part in parts] 36 | nav[tuple(nav_parts)] = doc_path.as_posix() 37 | 38 | with mkdocs_gen_files.open(full_doc_path, "w") as fd: 39 | ident = ".".join(parts) 40 | fd.write(f"---\ntitle: {ident}\n---\n\n::: {ident}") 41 | 42 | mkdocs_gen_files.set_edit_path(full_doc_path, path.relative_to(packages_dir)) 43 | 44 | with mkdocs_gen_files.open(doc_root / "reference" / "SUMMARY.md", "w") as nav_file: 45 | nav_file.writelines(nav.build_literate_nav()) 46 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_archivedotorg/abx_plugin_archivedotorg.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_archivedotorg` 2 | 3 | ```{py:module} abx_plugin_archivedotorg 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_archivedotorg 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_archivedotorg.archive_org 17 | abx_plugin_archivedotorg.config 18 | ``` 19 | 20 | ## Package Contents 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`get_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.get_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### Data 35 | 36 | ````{list-table} 37 | :class: autosummary longtable 38 | :align: left 39 | 40 | * - {py:obj}`__label__ ` 41 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.__label__ 42 | :summary: 43 | ``` 44 | * - {py:obj}`__homepage__ ` 45 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.__homepage__ 46 | :summary: 47 | ``` 48 | ```` 49 | 50 | ### API 51 | 52 | ````{py:data} __label__ 53 | :canonical: abx_plugin_archivedotorg.__label__ 54 | :value: > 55 | 'Archive.org' 56 | 57 | ```{autodoc2-docstring} abx_plugin_archivedotorg.__label__ 58 | ``` 59 | 60 | ```` 61 | 62 | ````{py:data} __homepage__ 63 | :canonical: abx_plugin_archivedotorg.__homepage__ 64 | :value: > 65 | 'https://archive.org' 66 | 67 | ```{autodoc2-docstring} abx_plugin_archivedotorg.__homepage__ 68 | ``` 69 | 70 | ```` 71 | 72 | ````{py:function} get_CONFIG() 73 | :canonical: abx_plugin_archivedotorg.get_CONFIG 74 | 75 | ```{autodoc2-docstring} abx_plugin_archivedotorg.get_CONFIG 76 | ``` 77 | ```` 78 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_favicon/abx_plugin_favicon.favicon.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_favicon.favicon` 2 | 3 | ```{py:module} abx_plugin_favicon.favicon 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_favicon.favicon 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`should_save_favicon ` 19 | - ```{autodoc2-docstring} abx_plugin_favicon.favicon.should_save_favicon 20 | :summary: 21 | ``` 22 | * - {py:obj}`get_output_path ` 23 | - ```{autodoc2-docstring} abx_plugin_favicon.favicon.get_output_path 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_favicon ` 27 | - ```{autodoc2-docstring} abx_plugin_favicon.favicon.save_favicon 28 | :summary: 29 | ``` 30 | ```` 31 | 32 | ### API 33 | 34 | ````{py:function} should_save_favicon(link: archivebox.index.schema.Link, out_dir: str | pathlib.Path | None = None, overwrite: bool = False) -> bool 35 | :canonical: abx_plugin_favicon.favicon.should_save_favicon 36 | 37 | ```{autodoc2-docstring} abx_plugin_favicon.favicon.should_save_favicon 38 | ``` 39 | ```` 40 | 41 | ````{py:function} get_output_path() 42 | :canonical: abx_plugin_favicon.favicon.get_output_path 43 | 44 | ```{autodoc2-docstring} abx_plugin_favicon.favicon.get_output_path 45 | ``` 46 | ```` 47 | 48 | ````{py:function} save_favicon(link: archivebox.index.schema.Link, out_dir: str | pathlib.Path | None = None, timeout: int = CURL_CONFIG.CURL_TIMEOUT) -> archivebox.index.schema.ArchiveResult 49 | :canonical: abx_plugin_favicon.favicon.save_favicon 50 | 51 | ```{autodoc2-docstring} abx_plugin_favicon.favicon.save_favicon 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_sqlitefts_search/abx_plugin_sqlitefts_search.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_sqlitefts_search` 2 | 3 | ```{py:module} abx_plugin_sqlitefts_search 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_sqlitefts_search 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_sqlitefts_search.searchbackend 17 | abx_plugin_sqlitefts_search.config 18 | ``` 19 | 20 | ## Package Contents 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`get_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.get_CONFIG 30 | :summary: 31 | ``` 32 | * - {py:obj}`get_SEARCHBACKENDS ` 33 | - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.get_SEARCHBACKENDS 34 | :summary: 35 | ``` 36 | ```` 37 | 38 | ### Data 39 | 40 | ````{list-table} 41 | :class: autosummary longtable 42 | :align: left 43 | 44 | * - {py:obj}`__label__ ` 45 | - ```{autodoc2-docstring} abx_plugin_sqlitefts_search.__label__ 46 | :summary: 47 | ``` 48 | ```` 49 | 50 | ### API 51 | 52 | ````{py:data} __label__ 53 | :canonical: abx_plugin_sqlitefts_search.__label__ 54 | :value: > 55 | 'SQLiteFTS Search' 56 | 57 | ```{autodoc2-docstring} abx_plugin_sqlitefts_search.__label__ 58 | ``` 59 | 60 | ```` 61 | 62 | ````{py:function} get_CONFIG() 63 | :canonical: abx_plugin_sqlitefts_search.get_CONFIG 64 | 65 | ```{autodoc2-docstring} abx_plugin_sqlitefts_search.get_CONFIG 66 | ``` 67 | ```` 68 | 69 | ````{py:function} get_SEARCHBACKENDS() 70 | :canonical: abx_plugin_sqlitefts_search.get_SEARCHBACKENDS 71 | 72 | ```{autodoc2-docstring} abx_plugin_sqlitefts_search.get_SEARCHBACKENDS 73 | ``` 74 | ```` 75 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_puppeteer/abx_plugin_puppeteer.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_puppeteer.binaries` 2 | 3 | ```{py:module} abx_plugin_puppeteer.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_puppeteer.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`PuppeteerBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`PUPPETEER_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_puppeteer.binaries.PUPPETEER_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} PuppeteerBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_puppeteer.binaries.PuppeteerBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_puppeteer.binaries.PuppeteerBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | 'puppeteer' 46 | 47 | ```{autodoc2-docstring} abx_plugin_puppeteer.binaries.PuppeteerBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_puppeteer.binaries.PuppeteerBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_puppeteer.binaries.PuppeteerBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````` 64 | 65 | ````{py:data} PUPPETEER_BINARY 66 | :canonical: abx_plugin_puppeteer.binaries.PUPPETEER_BINARY 67 | :value: > 68 | 'PuppeteerBinary(...)' 69 | 70 | ```{autodoc2-docstring} abx_plugin_puppeteer.binaries.PUPPETEER_BINARY 71 | ``` 72 | 73 | ```` 74 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_chrome/abx_plugin_chrome.screenshot.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_chrome.screenshot` 2 | 3 | ```{py:module} abx_plugin_chrome.screenshot 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_chrome.screenshot 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_chrome.screenshot.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`should_save_screenshot ` 23 | - ```{autodoc2-docstring} abx_plugin_chrome.screenshot.should_save_screenshot 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_screenshot ` 27 | - ```{autodoc2-docstring} abx_plugin_chrome.screenshot.save_screenshot 28 | :summary: 29 | ``` 30 | ```` 31 | 32 | ### API 33 | 34 | ````{py:function} get_output_path() 35 | :canonical: abx_plugin_chrome.screenshot.get_output_path 36 | 37 | ```{autodoc2-docstring} abx_plugin_chrome.screenshot.get_output_path 38 | ``` 39 | ```` 40 | 41 | ````{py:function} should_save_screenshot(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 42 | :canonical: abx_plugin_chrome.screenshot.should_save_screenshot 43 | 44 | ```{autodoc2-docstring} abx_plugin_chrome.screenshot.should_save_screenshot 45 | ``` 46 | ```` 47 | 48 | ````{py:function} save_screenshot(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = 60) -> archivebox.index.schema.ArchiveResult 49 | :canonical: abx_plugin_chrome.screenshot.save_screenshot 50 | 51 | ```{autodoc2-docstring} abx_plugin_chrome.screenshot.save_screenshot 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_playwright/abx_plugin_playwright.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_playwright.binaries` 2 | 3 | ```{py:module} abx_plugin_playwright.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_playwright.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`PlaywrightBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`PLAYWRIGHT_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_playwright.binaries.PLAYWRIGHT_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} PlaywrightBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_playwright.binaries.PlaywrightBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_playwright.binaries.PlaywrightBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_playwright.binaries.PlaywrightBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_playwright.binaries.PlaywrightBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_playwright.binaries.PlaywrightBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````` 64 | 65 | ````{py:data} PLAYWRIGHT_BINARY 66 | :canonical: abx_plugin_playwright.binaries.PLAYWRIGHT_BINARY 67 | :value: > 68 | 'PlaywrightBinary(...)' 69 | 70 | ```{autodoc2-docstring} abx_plugin_playwright.binaries.PLAYWRIGHT_BINARY 71 | ``` 72 | 73 | ```` 74 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.machine.apps.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.machine.apps` 2 | 3 | ```{py:module} archivebox.machine.apps 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.machine.apps 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`MachineConfig ` 19 | - 20 | ```` 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`register_admin ` 29 | - ```{autodoc2-docstring} archivebox.machine.apps.register_admin 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} MachineConfig(app_name, app_module) 37 | :canonical: archivebox.machine.apps.MachineConfig 38 | 39 | Bases: {py:obj}`django.apps.AppConfig` 40 | 41 | ````{py:attribute} default_auto_field 42 | :canonical: archivebox.machine.apps.MachineConfig.default_auto_field 43 | :value: > 44 | 'django.db.models.BigAutoField' 45 | 46 | ```{autodoc2-docstring} archivebox.machine.apps.MachineConfig.default_auto_field 47 | ``` 48 | 49 | ```` 50 | 51 | ````{py:attribute} name 52 | :canonical: archivebox.machine.apps.MachineConfig.name 53 | :value: > 54 | 'machine' 55 | 56 | ```{autodoc2-docstring} archivebox.machine.apps.MachineConfig.name 57 | ``` 58 | 59 | ```` 60 | 61 | ````{py:attribute} verbose_name 62 | :canonical: archivebox.machine.apps.MachineConfig.verbose_name 63 | :value: > 64 | 'Machine Info' 65 | 66 | ```{autodoc2-docstring} archivebox.machine.apps.MachineConfig.verbose_name 67 | ``` 68 | 69 | ```` 70 | 71 | ````` 72 | 73 | ````{py:function} register_admin(admin_site) 74 | :canonical: archivebox.machine.apps.register_admin 75 | 76 | ```{autodoc2-docstring} archivebox.machine.apps.register_admin 77 | ``` 78 | ```` 79 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_singlefile/abx_plugin_singlefile.singlefile.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_singlefile.singlefile` 2 | 3 | ```{py:module} abx_plugin_singlefile.singlefile 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_singlefile.singlefile 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_singlefile.singlefile.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`should_save_singlefile ` 23 | - ```{autodoc2-docstring} abx_plugin_singlefile.singlefile.should_save_singlefile 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_singlefile ` 27 | - ```{autodoc2-docstring} abx_plugin_singlefile.singlefile.save_singlefile 28 | :summary: 29 | ``` 30 | ```` 31 | 32 | ### API 33 | 34 | ````{py:function} get_output_path() 35 | :canonical: abx_plugin_singlefile.singlefile.get_output_path 36 | 37 | ```{autodoc2-docstring} abx_plugin_singlefile.singlefile.get_output_path 38 | ``` 39 | ```` 40 | 41 | ````{py:function} should_save_singlefile(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 42 | :canonical: abx_plugin_singlefile.singlefile.should_save_singlefile 43 | 44 | ```{autodoc2-docstring} abx_plugin_singlefile.singlefile.should_save_singlefile 45 | ``` 46 | ```` 47 | 48 | ````{py:function} save_singlefile(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = 60) -> archivebox.index.schema.ArchiveResult 49 | :canonical: abx_plugin_singlefile.singlefile.save_singlefile 50 | 51 | ```{autodoc2-docstring} abx_plugin_singlefile.singlefile.save_singlefile 52 | ``` 53 | ```` 54 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_git/abx_plugin_git.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_git` 2 | 3 | ```{py:module} abx_plugin_git 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_git 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_git.git 17 | abx_plugin_git.config 18 | abx_plugin_git.extractors 19 | abx_plugin_git.binaries 20 | ``` 21 | 22 | ## Package Contents 23 | 24 | ### Functions 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`get_CONFIG ` 31 | - ```{autodoc2-docstring} abx_plugin_git.get_CONFIG 32 | :summary: 33 | ``` 34 | * - {py:obj}`get_BINARIES ` 35 | - ```{autodoc2-docstring} abx_plugin_git.get_BINARIES 36 | :summary: 37 | ``` 38 | * - {py:obj}`get_EXTRACTORS ` 39 | - ```{autodoc2-docstring} abx_plugin_git.get_EXTRACTORS 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### Data 45 | 46 | ````{list-table} 47 | :class: autosummary longtable 48 | :align: left 49 | 50 | * - {py:obj}`__label__ ` 51 | - ```{autodoc2-docstring} abx_plugin_git.__label__ 52 | :summary: 53 | ``` 54 | ```` 55 | 56 | ### API 57 | 58 | ````{py:data} __label__ 59 | :canonical: abx_plugin_git.__label__ 60 | :value: > 61 | 'Git' 62 | 63 | ```{autodoc2-docstring} abx_plugin_git.__label__ 64 | ``` 65 | 66 | ```` 67 | 68 | ````{py:function} get_CONFIG() 69 | :canonical: abx_plugin_git.get_CONFIG 70 | 71 | ```{autodoc2-docstring} abx_plugin_git.get_CONFIG 72 | ``` 73 | ```` 74 | 75 | ````{py:function} get_BINARIES() 76 | :canonical: abx_plugin_git.get_BINARIES 77 | 78 | ```{autodoc2-docstring} abx_plugin_git.get_BINARIES 79 | ``` 80 | ```` 81 | 82 | ````{py:function} get_EXTRACTORS() 83 | :canonical: abx_plugin_git.get_EXTRACTORS 84 | 85 | ```{autodoc2-docstring} abx_plugin_git.get_EXTRACTORS 86 | ``` 87 | ```` 88 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_git/abx_plugin_git.git.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_git.git` 2 | 3 | ```{py:module} abx_plugin_git.git 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_git.git 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_git.git.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`get_embed_path ` 23 | - ```{autodoc2-docstring} abx_plugin_git.git.get_embed_path 24 | :summary: 25 | ``` 26 | * - {py:obj}`should_save_git ` 27 | - ```{autodoc2-docstring} abx_plugin_git.git.should_save_git 28 | :summary: 29 | ``` 30 | * - {py:obj}`save_git ` 31 | - ```{autodoc2-docstring} abx_plugin_git.git.save_git 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:function} get_output_path() 39 | :canonical: abx_plugin_git.git.get_output_path 40 | 41 | ```{autodoc2-docstring} abx_plugin_git.git.get_output_path 42 | ``` 43 | ```` 44 | 45 | ````{py:function} get_embed_path(archiveresult=None) 46 | :canonical: abx_plugin_git.git.get_embed_path 47 | 48 | ```{autodoc2-docstring} abx_plugin_git.git.get_embed_path 49 | ``` 50 | ```` 51 | 52 | ````{py:function} should_save_git(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 53 | :canonical: abx_plugin_git.git.should_save_git 54 | 55 | ```{autodoc2-docstring} abx_plugin_git.git.should_save_git 56 | ``` 57 | ```` 58 | 59 | ````{py:function} save_git(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = GIT_CONFIG.GIT_TIMEOUT) -> archivebox.index.schema.ArchiveResult 60 | :canonical: abx_plugin_git.git.save_git 61 | 62 | ```{autodoc2-docstring} abx_plugin_git.git.save_git 63 | ``` 64 | ```` 65 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_mercury/abx_plugin_mercury.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_mercury.binaries` 2 | 3 | ```{py:module} abx_plugin_mercury.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_mercury.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`MercuryBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`MERCURY_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_mercury.binaries.MERCURY_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} MercuryBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_mercury.binaries.MercuryBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_mercury.binaries.MercuryBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_mercury.binaries.MercuryBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_mercury.binaries.MercuryBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_mercury.binaries.MercuryBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:attribute} overrides 64 | :canonical: abx_plugin_mercury.binaries.MercuryBinary.overrides 65 | :type: abx_pkg.BinaryOverrides 66 | :value: > 67 | None 68 | 69 | ```{autodoc2-docstring} abx_plugin_mercury.binaries.MercuryBinary.overrides 70 | ``` 71 | 72 | ```` 73 | 74 | ````` 75 | 76 | ````{py:data} MERCURY_BINARY 77 | :canonical: abx_plugin_mercury.binaries.MERCURY_BINARY 78 | :value: > 79 | 'MercuryBinary(...)' 80 | 81 | ```{autodoc2-docstring} abx_plugin_mercury.binaries.MERCURY_BINARY 82 | ``` 83 | 84 | ```` 85 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_ytdlp/abx_plugin_ytdlp.media.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_ytdlp.media` 2 | 3 | ```{py:module} abx_plugin_ytdlp.media 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_ytdlp.media 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_ytdlp.media.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`get_embed_path ` 23 | - ```{autodoc2-docstring} abx_plugin_ytdlp.media.get_embed_path 24 | :summary: 25 | ``` 26 | * - {py:obj}`should_save_media ` 27 | - ```{autodoc2-docstring} abx_plugin_ytdlp.media.should_save_media 28 | :summary: 29 | ``` 30 | * - {py:obj}`save_media ` 31 | - ```{autodoc2-docstring} abx_plugin_ytdlp.media.save_media 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:function} get_output_path() 39 | :canonical: abx_plugin_ytdlp.media.get_output_path 40 | 41 | ```{autodoc2-docstring} abx_plugin_ytdlp.media.get_output_path 42 | ``` 43 | ```` 44 | 45 | ````{py:function} get_embed_path(archiveresult=None) 46 | :canonical: abx_plugin_ytdlp.media.get_embed_path 47 | 48 | ```{autodoc2-docstring} abx_plugin_ytdlp.media.get_embed_path 49 | ``` 50 | ```` 51 | 52 | ````{py:function} should_save_media(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 53 | :canonical: abx_plugin_ytdlp.media.should_save_media 54 | 55 | ```{autodoc2-docstring} abx_plugin_ytdlp.media.should_save_media 56 | ``` 57 | ```` 58 | 59 | ````{py:function} save_media(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = 0) -> archivebox.index.schema.ArchiveResult 60 | :canonical: abx_plugin_ytdlp.media.save_media 61 | 62 | ```{autodoc2-docstring} abx_plugin_ytdlp.media.save_media 63 | ``` 64 | ```` 65 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_git/abx_plugin_git.extractors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_git.extractors` 2 | 3 | ```{py:module} abx_plugin_git.extractors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_git.extractors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`GitExtractor ` 19 | - ```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`GIT_EXTRACTOR ` 31 | - ```{autodoc2-docstring} abx_plugin_git.extractors.GIT_EXTRACTOR 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | `````{py:class} GitExtractor 39 | :canonical: abx_plugin_git.extractors.GitExtractor 40 | 41 | Bases: {py:obj}`abx_spec_extractor.BaseExtractor` 42 | 43 | ```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor 44 | ``` 45 | 46 | ````{py:attribute} name 47 | :canonical: abx_plugin_git.extractors.GitExtractor.name 48 | :type: abx_spec_extractor.ExtractorName 49 | :value: > 50 | 'git' 51 | 52 | ```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor.name 53 | ``` 54 | 55 | ```` 56 | 57 | ````{py:attribute} binary 58 | :canonical: abx_plugin_git.extractors.GitExtractor.binary 59 | :type: abx_pkg.BinName 60 | :value: > 61 | None 62 | 63 | ```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor.binary 64 | ``` 65 | 66 | ```` 67 | 68 | ````{py:method} get_output_path(snapshot) -> pathlib.Path | None 69 | :canonical: abx_plugin_git.extractors.GitExtractor.get_output_path 70 | 71 | ```{autodoc2-docstring} abx_plugin_git.extractors.GitExtractor.get_output_path 72 | ``` 73 | 74 | ```` 75 | 76 | ````` 77 | 78 | ````{py:data} GIT_EXTRACTOR 79 | :canonical: abx_plugin_git.extractors.GIT_EXTRACTOR 80 | :value: > 81 | 'GitExtractor(...)' 82 | 83 | ```{autodoc2-docstring} abx_plugin_git.extractors.GIT_EXTRACTOR 84 | ``` 85 | 86 | ```` 87 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_sonic_search/abx_plugin_sonic_search.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_sonic_search.binaries` 2 | 3 | ```{py:module} abx_plugin_sonic_search.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_sonic_search.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SonicBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`SONIC_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_sonic_search.binaries.SONIC_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} SonicBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_sonic_search.binaries.SonicBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_sonic_search.binaries.SonicBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_sonic_search.binaries.SonicBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_sonic_search.binaries.SonicBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_sonic_search.binaries.SonicBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:attribute} overrides 64 | :canonical: abx_plugin_sonic_search.binaries.SonicBinary.overrides 65 | :type: abx_pkg.BinaryOverrides 66 | :value: > 67 | None 68 | 69 | ```{autodoc2-docstring} abx_plugin_sonic_search.binaries.SonicBinary.overrides 70 | ``` 71 | 72 | ```` 73 | 74 | ````` 75 | 76 | ````{py:data} SONIC_BINARY 77 | :canonical: abx_plugin_sonic_search.binaries.SONIC_BINARY 78 | :value: > 79 | 'SonicBinary(...)' 80 | 81 | ```{autodoc2-docstring} abx_plugin_sonic_search.binaries.SONIC_BINARY 82 | ``` 83 | 84 | ```` 85 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.medium_rss.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.medium_rss` 2 | 3 | ```{py:module} archivebox.parsers.medium_rss 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.medium_rss 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_medium_rss_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.medium_rss.parse_medium_rss_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.medium_rss.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.medium_rss.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.medium_rss.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_medium_rss_export(rss_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.medium_rss.parse_medium_rss_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.medium_rss.parse_medium_rss_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.medium_rss.KEY 55 | :value: > 56 | 'medium_rss' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.medium_rss.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.medium_rss.NAME 65 | :value: > 66 | 'Medium RSS' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.medium_rss.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.medium_rss.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.medium_rss.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.generic_rss.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.generic_rss` 2 | 3 | ```{py:module} archivebox.parsers.generic_rss 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.generic_rss 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_generic_rss_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.generic_rss.parse_generic_rss_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.generic_rss.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.generic_rss.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.generic_rss.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_generic_rss_export(rss_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.generic_rss.parse_generic_rss_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.generic_rss.parse_generic_rss_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.generic_rss.KEY 55 | :value: > 56 | 'rss' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.generic_rss.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.generic_rss.NAME 65 | :value: > 66 | 'Generic RSS' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.generic_rss.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.generic_rss.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.generic_rss.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.pocket_html.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.pocket_html` 2 | 3 | ```{py:module} archivebox.parsers.pocket_html 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.pocket_html 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_pocket_html_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.pocket_html.parse_pocket_html_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.pocket_html.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.pocket_html.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.pocket_html.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_pocket_html_export(html_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.pocket_html.parse_pocket_html_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.pocket_html.parse_pocket_html_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.pocket_html.KEY 55 | :value: > 56 | 'pocket_html' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.pocket_html.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.pocket_html.NAME 65 | :value: > 66 | 'Pocket HTML' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.pocket_html.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.pocket_html.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.pocket_html.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.shaarli_rss.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.shaarli_rss` 2 | 3 | ```{py:module} archivebox.parsers.shaarli_rss 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.shaarli_rss 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_shaarli_rss_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.parse_shaarli_rss_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_shaarli_rss_export(rss_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.shaarli_rss.parse_shaarli_rss_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.parse_shaarli_rss_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.shaarli_rss.KEY 55 | :value: > 56 | 'shaarli_rss' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.shaarli_rss.NAME 65 | :value: > 66 | 'Shaarli RSS' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.shaarli_rss.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.shaarli_rss.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.pinboard_rss.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.pinboard_rss` 2 | 3 | ```{py:module} archivebox.parsers.pinboard_rss 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.pinboard_rss 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_pinboard_rss_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.parse_pinboard_rss_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_pinboard_rss_export(rss_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.pinboard_rss.parse_pinboard_rss_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.parse_pinboard_rss_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.pinboard_rss.KEY 55 | :value: > 56 | 'pinboard_rss' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.pinboard_rss.NAME 65 | :value: > 66 | 'Pinboard RSS' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.pinboard_rss.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.pinboard_rss.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_ripgrep_search/abx_plugin_ripgrep_search.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_ripgrep_search.binaries` 2 | 3 | ```{py:module} abx_plugin_ripgrep_search.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`RipgrepBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`RIPGREP_BINARY ` 29 | - ```{autodoc2-docstring} abx_plugin_ripgrep_search.binaries.RIPGREP_BINARY 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} RipgrepBinary(/, **data: typing.Any) 37 | :canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary 38 | 39 | Bases: {py:obj}`abx_pkg.Binary` 40 | 41 | ````{py:attribute} name 42 | :canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary.name 43 | :type: abx_pkg.BinName 44 | :value: > 45 | None 46 | 47 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.binaries.RipgrepBinary.name 48 | ``` 49 | 50 | ```` 51 | 52 | ````{py:attribute} binproviders_supported 53 | :canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary.binproviders_supported 54 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 55 | :value: > 56 | None 57 | 58 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.binaries.RipgrepBinary.binproviders_supported 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:attribute} overrides 64 | :canonical: abx_plugin_ripgrep_search.binaries.RipgrepBinary.overrides 65 | :type: abx_pkg.BinaryOverrides 66 | :value: > 67 | None 68 | 69 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.binaries.RipgrepBinary.overrides 70 | ``` 71 | 72 | ```` 73 | 74 | ````` 75 | 76 | ````{py:data} RIPGREP_BINARY 77 | :canonical: abx_plugin_ripgrep_search.binaries.RIPGREP_BINARY 78 | :value: > 79 | 'RipgrepBinary(...)' 80 | 81 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.binaries.RIPGREP_BINARY 82 | ``` 83 | 84 | ```` 85 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_npm/abx_plugin_npm.config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_npm.config` 2 | 3 | ```{py:module} abx_plugin_npm.config 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_npm.config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`NpmDependencyConfigs ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`NPM_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_npm.config.NPM_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | ```{py:class} NpmDependencyConfigs(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any) 37 | :canonical: abx_plugin_npm.config.NpmDependencyConfigs 38 | 39 | Bases: {py:obj}`abx_spec_config.BaseConfigSet` 40 | 41 | ``` 42 | 43 | ````{py:data} NPM_CONFIG 44 | :canonical: abx_plugin_npm.config.NPM_CONFIG 45 | :value: > 46 | 'NpmDependencyConfigs(...)' 47 | 48 | ```{autodoc2-docstring} abx_plugin_npm.config.NPM_CONFIG 49 | ``` 50 | 51 | ```` 52 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.netscape_html.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.netscape_html` 2 | 3 | ```{py:module} archivebox.parsers.netscape_html 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.netscape_html 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_netscape_html_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.netscape_html.parse_netscape_html_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.netscape_html.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.netscape_html.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.netscape_html.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_netscape_html_export(html_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.netscape_html.parse_netscape_html_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.netscape_html.parse_netscape_html_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.netscape_html.KEY 55 | :value: > 56 | 'netscape_html' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.netscape_html.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.netscape_html.NAME 65 | :value: > 66 | 'Netscape HTML' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.netscape_html.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.netscape_html.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.netscape_html.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.wallabag_atom.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.wallabag_atom` 2 | 3 | ```{py:module} archivebox.parsers.wallabag_atom 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.wallabag_atom 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_wallabag_atom_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.parse_wallabag_atom_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`KEY ` 31 | - ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.KEY 32 | :summary: 33 | ``` 34 | * - {py:obj}`NAME ` 35 | - ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.NAME 36 | :summary: 37 | ``` 38 | * - {py:obj}`PARSER ` 39 | - ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.PARSER 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:function} parse_wallabag_atom_export(rss_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 47 | :canonical: archivebox.parsers.wallabag_atom.parse_wallabag_atom_export 48 | 49 | ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.parse_wallabag_atom_export 50 | ``` 51 | ```` 52 | 53 | ````{py:data} KEY 54 | :canonical: archivebox.parsers.wallabag_atom.KEY 55 | :value: > 56 | 'wallabag_atom' 57 | 58 | ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.KEY 59 | ``` 60 | 61 | ```` 62 | 63 | ````{py:data} NAME 64 | :canonical: archivebox.parsers.wallabag_atom.NAME 65 | :value: > 66 | 'Wallabag Atom' 67 | 68 | ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.NAME 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:data} PARSER 74 | :canonical: archivebox.parsers.wallabag_atom.PARSER 75 | :value: > 76 | None 77 | 78 | ```{autodoc2-docstring} archivebox.parsers.wallabag_atom.PARSER 79 | ``` 80 | 81 | ```` 82 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_favicon/abx_plugin_favicon.extractors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_favicon.extractors` 2 | 3 | ```{py:module} abx_plugin_favicon.extractors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_favicon.extractors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`FaviconExtractor ` 19 | - ```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`FAVICON_EXTRACTOR ` 31 | - ```{autodoc2-docstring} abx_plugin_favicon.extractors.FAVICON_EXTRACTOR 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | `````{py:class} FaviconExtractor 39 | :canonical: abx_plugin_favicon.extractors.FaviconExtractor 40 | 41 | Bases: {py:obj}`abx_spec_extractor.BaseExtractor` 42 | 43 | ```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor 44 | ``` 45 | 46 | ````{py:attribute} name 47 | :canonical: abx_plugin_favicon.extractors.FaviconExtractor.name 48 | :type: abx_spec_extractor.ExtractorName 49 | :value: > 50 | 'favicon' 51 | 52 | ```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor.name 53 | ``` 54 | 55 | ```` 56 | 57 | ````{py:attribute} binary 58 | :canonical: abx_plugin_favicon.extractors.FaviconExtractor.binary 59 | :type: abx_pkg.BinName 60 | :value: > 61 | None 62 | 63 | ```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor.binary 64 | ``` 65 | 66 | ```` 67 | 68 | ````{py:method} get_output_path(snapshot) -> pathlib.Path | None 69 | :canonical: abx_plugin_favicon.extractors.FaviconExtractor.get_output_path 70 | 71 | ```{autodoc2-docstring} abx_plugin_favicon.extractors.FaviconExtractor.get_output_path 72 | ``` 73 | 74 | ```` 75 | 76 | ````` 77 | 78 | ````{py:data} FAVICON_EXTRACTOR 79 | :canonical: abx_plugin_favicon.extractors.FAVICON_EXTRACTOR 80 | :value: > 81 | 'FaviconExtractor(...)' 82 | 83 | ```{autodoc2-docstring} abx_plugin_favicon.extractors.FAVICON_EXTRACTOR 84 | ``` 85 | 86 | ```` 87 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_mercury/abx_plugin_mercury.extractors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_mercury.extractors` 2 | 3 | ```{py:module} abx_plugin_mercury.extractors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_mercury.extractors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`MercuryExtractor ` 19 | - ```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`MERCURY_EXTRACTOR ` 31 | - ```{autodoc2-docstring} abx_plugin_mercury.extractors.MERCURY_EXTRACTOR 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | `````{py:class} MercuryExtractor 39 | :canonical: abx_plugin_mercury.extractors.MercuryExtractor 40 | 41 | Bases: {py:obj}`abx_spec_extractor.BaseExtractor` 42 | 43 | ```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor 44 | ``` 45 | 46 | ````{py:attribute} name 47 | :canonical: abx_plugin_mercury.extractors.MercuryExtractor.name 48 | :type: abx_spec_extractor.ExtractorName 49 | :value: > 50 | 'mercury' 51 | 52 | ```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor.name 53 | ``` 54 | 55 | ```` 56 | 57 | ````{py:attribute} binary 58 | :canonical: abx_plugin_mercury.extractors.MercuryExtractor.binary 59 | :type: abx_pkg.BinName 60 | :value: > 61 | None 62 | 63 | ```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor.binary 64 | ``` 65 | 66 | ```` 67 | 68 | ````{py:method} get_output_path(snapshot) -> pathlib.Path | None 69 | :canonical: abx_plugin_mercury.extractors.MercuryExtractor.get_output_path 70 | 71 | ```{autodoc2-docstring} abx_plugin_mercury.extractors.MercuryExtractor.get_output_path 72 | ``` 73 | 74 | ```` 75 | 76 | ````` 77 | 78 | ````{py:data} MERCURY_EXTRACTOR 79 | :canonical: abx_plugin_mercury.extractors.MERCURY_EXTRACTOR 80 | :value: > 81 | 'MercuryExtractor(...)' 82 | 83 | ```{autodoc2-docstring} abx_plugin_mercury.extractors.MERCURY_EXTRACTOR 84 | ``` 85 | 86 | ```` 87 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core` 2 | 3 | ```{py:module} archivebox.core 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core 7 | :allowtitles: 8 | ``` 9 | 10 | ## Subpackages 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 3 15 | 16 | archivebox.core.templatetags 17 | ``` 18 | 19 | ## Submodules 20 | 21 | ```{toctree} 22 | :titlesonly: 23 | :maxdepth: 1 24 | 25 | archivebox.core.admin_archiveresults 26 | archivebox.core.admin_tags 27 | archivebox.core.models 28 | archivebox.core.admin_users 29 | archivebox.core.asgi 30 | archivebox.core.settings_logging 31 | archivebox.core.apps 32 | archivebox.core.admin_snapshots 33 | archivebox.core.forms 34 | archivebox.core.admin 35 | archivebox.core.statemachines 36 | archivebox.core.admin_site 37 | archivebox.core.settings 38 | archivebox.core.actors 39 | archivebox.core.urls 40 | archivebox.core.middleware 41 | archivebox.core.views 42 | archivebox.core.wsgi 43 | ``` 44 | 45 | ## Package Contents 46 | 47 | ### Functions 48 | 49 | ````{list-table} 50 | :class: autosummary longtable 51 | :align: left 52 | 53 | * - {py:obj}`register_admin ` 54 | - ```{autodoc2-docstring} archivebox.core.register_admin 55 | :summary: 56 | ``` 57 | * - {py:obj}`get_CONFIG ` 58 | - ```{autodoc2-docstring} archivebox.core.get_CONFIG 59 | :summary: 60 | ``` 61 | ```` 62 | 63 | ### Data 64 | 65 | ````{list-table} 66 | :class: autosummary longtable 67 | :align: left 68 | 69 | * - {py:obj}`__order__ ` 70 | - ```{autodoc2-docstring} archivebox.core.__order__ 71 | :summary: 72 | ``` 73 | ```` 74 | 75 | ### API 76 | 77 | ````{py:data} __order__ 78 | :canonical: archivebox.core.__order__ 79 | :value: > 80 | 100 81 | 82 | ```{autodoc2-docstring} archivebox.core.__order__ 83 | ``` 84 | 85 | ```` 86 | 87 | ````{py:function} register_admin(admin_site) 88 | :canonical: archivebox.core.register_admin 89 | 90 | ```{autodoc2-docstring} archivebox.core.register_admin 91 | ``` 92 | ```` 93 | 94 | ````{py:function} get_CONFIG() 95 | :canonical: archivebox.core.get_CONFIG 96 | 97 | ```{autodoc2-docstring} archivebox.core.get_CONFIG 98 | ``` 99 | ```` 100 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_singlefile/abx_plugin_singlefile.actors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_singlefile.actors` 2 | 3 | ```{py:module} abx_plugin_singlefile.actors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_singlefile.actors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SinglefileActor ` 19 | - ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### API 25 | 26 | `````{py:class} SinglefileActor 27 | :canonical: abx_plugin_singlefile.actors.SinglefileActor 28 | 29 | Bases: {py:obj}`actors.actor.ActorType`\[{py:obj}`abx_plugin_singlefile.models.SinglefileResult`\] 30 | 31 | ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor 32 | ``` 33 | 34 | ````{py:attribute} CLAIM_ORDER 35 | :canonical: abx_plugin_singlefile.actors.SinglefileActor.CLAIM_ORDER 36 | :type: typing.ClassVar[str] 37 | :value: > 38 | 'created_at DESC' 39 | 40 | ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor.CLAIM_ORDER 41 | ``` 42 | 43 | ```` 44 | 45 | ````{py:attribute} CLAIM_WHERE 46 | :canonical: abx_plugin_singlefile.actors.SinglefileActor.CLAIM_WHERE 47 | :type: typing.ClassVar[str] 48 | :value: > 49 | 'status = "queued" AND extractor = "favicon"' 50 | 51 | ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor.CLAIM_WHERE 52 | ``` 53 | 54 | ```` 55 | 56 | ````{py:attribute} CLAIM_SET 57 | :canonical: abx_plugin_singlefile.actors.SinglefileActor.CLAIM_SET 58 | :type: typing.ClassVar[str] 59 | :value: > 60 | 'status = "started"' 61 | 62 | ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor.CLAIM_SET 63 | ``` 64 | 65 | ```` 66 | 67 | ````{py:method} QUERYSET() -> django.db.models.QuerySet 68 | :canonical: abx_plugin_singlefile.actors.SinglefileActor.QUERYSET 69 | 70 | ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor.QUERYSET 71 | ``` 72 | 73 | ```` 74 | 75 | ````{py:method} tick(obj: abx_plugin_singlefile.models.SinglefileResult) 76 | :canonical: abx_plugin_singlefile.actors.SinglefileActor.tick 77 | 78 | ```{autodoc2-docstring} abx_plugin_singlefile.actors.SinglefileActor.tick 79 | ``` 80 | 81 | ```` 82 | 83 | ````` 84 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_pip/abx_plugin_pip.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_pip` 2 | 3 | ```{py:module} abx_plugin_pip 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_pip 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_pip.config 17 | abx_plugin_pip.binaries 18 | abx_plugin_pip.binproviders 19 | ``` 20 | 21 | ## Package Contents 22 | 23 | ### Functions 24 | 25 | ````{list-table} 26 | :class: autosummary longtable 27 | :align: left 28 | 29 | * - {py:obj}`get_CONFIG ` 30 | - ```{autodoc2-docstring} abx_plugin_pip.get_CONFIG 31 | :summary: 32 | ``` 33 | * - {py:obj}`get_BINARIES ` 34 | - ```{autodoc2-docstring} abx_plugin_pip.get_BINARIES 35 | :summary: 36 | ``` 37 | * - {py:obj}`get_BINPROVIDERS ` 38 | - ```{autodoc2-docstring} abx_plugin_pip.get_BINPROVIDERS 39 | :summary: 40 | ``` 41 | ```` 42 | 43 | ### Data 44 | 45 | ````{list-table} 46 | :class: autosummary longtable 47 | :align: left 48 | 49 | * - {py:obj}`__label__ ` 50 | - ```{autodoc2-docstring} abx_plugin_pip.__label__ 51 | :summary: 52 | ``` 53 | * - {py:obj}`__order__ ` 54 | - ```{autodoc2-docstring} abx_plugin_pip.__order__ 55 | :summary: 56 | ``` 57 | ```` 58 | 59 | ### API 60 | 61 | ````{py:data} __label__ 62 | :canonical: abx_plugin_pip.__label__ 63 | :value: > 64 | 'PIP' 65 | 66 | ```{autodoc2-docstring} abx_plugin_pip.__label__ 67 | ``` 68 | 69 | ```` 70 | 71 | ````{py:data} __order__ 72 | :canonical: abx_plugin_pip.__order__ 73 | :value: > 74 | 200 75 | 76 | ```{autodoc2-docstring} abx_plugin_pip.__order__ 77 | ``` 78 | 79 | ```` 80 | 81 | ````{py:function} get_CONFIG() 82 | :canonical: abx_plugin_pip.get_CONFIG 83 | 84 | ```{autodoc2-docstring} abx_plugin_pip.get_CONFIG 85 | ``` 86 | ```` 87 | 88 | ````{py:function} get_BINARIES() 89 | :canonical: abx_plugin_pip.get_BINARIES 90 | 91 | ```{autodoc2-docstring} abx_plugin_pip.get_BINARIES 92 | ``` 93 | ```` 94 | 95 | ````{py:function} get_BINPROVIDERS() 96 | :canonical: abx_plugin_pip.get_BINPROVIDERS 97 | 98 | ```{autodoc2-docstring} abx_plugin_pip.get_BINPROVIDERS 99 | ``` 100 | ```` 101 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_singlefile/abx_plugin_singlefile.extractors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_singlefile.extractors` 2 | 3 | ```{py:module} abx_plugin_singlefile.extractors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_singlefile.extractors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SinglefileExtractor ` 19 | - ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`SINGLEFILE_EXTRACTOR ` 31 | - ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | `````{py:class} SinglefileExtractor 39 | :canonical: abx_plugin_singlefile.extractors.SinglefileExtractor 40 | 41 | Bases: {py:obj}`abx_spec_extractor.BaseExtractor` 42 | 43 | ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor 44 | ``` 45 | 46 | ````{py:attribute} name 47 | :canonical: abx_plugin_singlefile.extractors.SinglefileExtractor.name 48 | :type: abx_spec_extractor.ExtractorName 49 | :value: > 50 | 'singlefile' 51 | 52 | ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor.name 53 | ``` 54 | 55 | ```` 56 | 57 | ````{py:attribute} binary 58 | :canonical: abx_plugin_singlefile.extractors.SinglefileExtractor.binary 59 | :type: abx_pkg.BinName 60 | :value: > 61 | None 62 | 63 | ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor.binary 64 | ``` 65 | 66 | ```` 67 | 68 | ````{py:method} get_output_path(snapshot) -> pathlib.Path 69 | :canonical: abx_plugin_singlefile.extractors.SinglefileExtractor.get_output_path 70 | 71 | ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SinglefileExtractor.get_output_path 72 | ``` 73 | 74 | ```` 75 | 76 | ````` 77 | 78 | ````{py:data} SINGLEFILE_EXTRACTOR 79 | :canonical: abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR 80 | :value: > 81 | 'SinglefileExtractor(...)' 82 | 83 | ```{autodoc2-docstring} abx_plugin_singlefile.extractors.SINGLEFILE_EXTRACTOR 84 | ``` 85 | 86 | ```` 87 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_wget/abx_plugin_wget.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_wget` 2 | 3 | ```{py:module} abx_plugin_wget 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_wget 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_wget.config 17 | abx_plugin_wget.extractors 18 | abx_plugin_wget.binaries 19 | abx_plugin_wget.wget_util 20 | abx_plugin_wget.wget 21 | ``` 22 | 23 | ## Package Contents 24 | 25 | ### Functions 26 | 27 | ````{list-table} 28 | :class: autosummary longtable 29 | :align: left 30 | 31 | * - {py:obj}`get_CONFIG ` 32 | - ```{autodoc2-docstring} abx_plugin_wget.get_CONFIG 33 | :summary: 34 | ``` 35 | * - {py:obj}`get_BINARIES ` 36 | - ```{autodoc2-docstring} abx_plugin_wget.get_BINARIES 37 | :summary: 38 | ``` 39 | * - {py:obj}`get_EXTRACTORS ` 40 | - ```{autodoc2-docstring} abx_plugin_wget.get_EXTRACTORS 41 | :summary: 42 | ``` 43 | * - {py:obj}`ready ` 44 | - ```{autodoc2-docstring} abx_plugin_wget.ready 45 | :summary: 46 | ``` 47 | ```` 48 | 49 | ### Data 50 | 51 | ````{list-table} 52 | :class: autosummary longtable 53 | :align: left 54 | 55 | * - {py:obj}`__label__ ` 56 | - ```{autodoc2-docstring} abx_plugin_wget.__label__ 57 | :summary: 58 | ``` 59 | ```` 60 | 61 | ### API 62 | 63 | ````{py:data} __label__ 64 | :canonical: abx_plugin_wget.__label__ 65 | :value: > 66 | 'WGET' 67 | 68 | ```{autodoc2-docstring} abx_plugin_wget.__label__ 69 | ``` 70 | 71 | ```` 72 | 73 | ````{py:function} get_CONFIG() 74 | :canonical: abx_plugin_wget.get_CONFIG 75 | 76 | ```{autodoc2-docstring} abx_plugin_wget.get_CONFIG 77 | ``` 78 | ```` 79 | 80 | ````{py:function} get_BINARIES() 81 | :canonical: abx_plugin_wget.get_BINARIES 82 | 83 | ```{autodoc2-docstring} abx_plugin_wget.get_BINARIES 84 | ``` 85 | ```` 86 | 87 | ````{py:function} get_EXTRACTORS() 88 | :canonical: abx_plugin_wget.get_EXTRACTORS 89 | 90 | ```{autodoc2-docstring} abx_plugin_wget.get_EXTRACTORS 91 | ``` 92 | ```` 93 | 94 | ````{py:function} ready() 95 | :canonical: abx_plugin_wget.ready 96 | 97 | ```{autodoc2-docstring} abx_plugin_wget.ready 98 | ``` 99 | ```` 100 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.cli.archivebox_add.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.cli.archivebox_add` 2 | 3 | ```{py:module} archivebox.cli.archivebox_add 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.cli.archivebox_add 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`add ` 19 | - ```{autodoc2-docstring} archivebox.cli.archivebox_add.add 20 | :summary: 21 | ``` 22 | * - {py:obj}`main ` 23 | - ```{autodoc2-docstring} archivebox.cli.archivebox_add.main 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### Data 29 | 30 | ````{list-table} 31 | :class: autosummary longtable 32 | :align: left 33 | 34 | * - {py:obj}`__command__ ` 35 | - ```{autodoc2-docstring} archivebox.cli.archivebox_add.__command__ 36 | :summary: 37 | ``` 38 | * - {py:obj}`ORCHESTRATOR ` 39 | - ```{autodoc2-docstring} archivebox.cli.archivebox_add.ORCHESTRATOR 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### API 45 | 46 | ````{py:data} __command__ 47 | :canonical: archivebox.cli.archivebox_add.__command__ 48 | :value: > 49 | 'archivebox add' 50 | 51 | ```{autodoc2-docstring} archivebox.cli.archivebox_add.__command__ 52 | ``` 53 | 54 | ```` 55 | 56 | ````{py:data} ORCHESTRATOR 57 | :canonical: archivebox.cli.archivebox_add.ORCHESTRATOR 58 | :value: > 59 | None 60 | 61 | ```{autodoc2-docstring} archivebox.cli.archivebox_add.ORCHESTRATOR 62 | ``` 63 | 64 | ```` 65 | 66 | ````{py:function} add(urls: str | list[str], tag: str = '', depth: int = 0, update: bool = not ARCHIVING_CONFIG.ONLY_NEW, update_all: bool = False, index_only: bool = False, overwrite: bool = False, extractors: str = '', parser: str = 'auto', persona: str = 'Default', created_by_id: int | None = None) -> django.db.models.QuerySet[core.models.Snapshot] 67 | :canonical: archivebox.cli.archivebox_add.add 68 | 69 | ```{autodoc2-docstring} archivebox.cli.archivebox_add.add 70 | ``` 71 | ```` 72 | 73 | ````{py:function} main(args: list[str] | None = None, stdin: typing.IO | None = None, pwd: str | None = None) -> None 74 | :canonical: archivebox.cli.archivebox_add.main 75 | 76 | ```{autodoc2-docstring} archivebox.cli.archivebox_add.main 77 | ``` 78 | ```` 79 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_readability/abx_plugin_readability.readability.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_readability.readability` 2 | 3 | ```{py:module} abx_plugin_readability.readability 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_readability.readability 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_readability.readability.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`get_embed_path ` 23 | - ```{autodoc2-docstring} abx_plugin_readability.readability.get_embed_path 24 | :summary: 25 | ``` 26 | * - {py:obj}`should_save_readability ` 27 | - ```{autodoc2-docstring} abx_plugin_readability.readability.should_save_readability 28 | :summary: 29 | ``` 30 | * - {py:obj}`save_readability ` 31 | - ```{autodoc2-docstring} abx_plugin_readability.readability.save_readability 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:function} get_output_path() 39 | :canonical: abx_plugin_readability.readability.get_output_path 40 | 41 | ```{autodoc2-docstring} abx_plugin_readability.readability.get_output_path 42 | ``` 43 | ```` 44 | 45 | ````{py:function} get_embed_path(archiveresult=None) 46 | :canonical: abx_plugin_readability.readability.get_embed_path 47 | 48 | ```{autodoc2-docstring} abx_plugin_readability.readability.get_embed_path 49 | ``` 50 | ```` 51 | 52 | ````{py:function} should_save_readability(link: archivebox.index.schema.Link, out_dir: typing.Optional[str] = None, overwrite: typing.Optional[bool] = False) -> bool 53 | :canonical: abx_plugin_readability.readability.should_save_readability 54 | 55 | ```{autodoc2-docstring} abx_plugin_readability.readability.should_save_readability 56 | ``` 57 | ```` 58 | 59 | ````{py:function} save_readability(link: archivebox.index.schema.Link, out_dir: typing.Optional[str] = None, timeout: int = 0) -> archivebox.index.schema.ArchiveResult 60 | :canonical: abx_plugin_readability.readability.save_readability 61 | 62 | ```{autodoc2-docstring} abx_plugin_readability.readability.save_readability 63 | ``` 64 | ```` 65 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_ytdlp/abx_plugin_ytdlp.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_ytdlp` 2 | 3 | ```{py:module} abx_plugin_ytdlp 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_ytdlp 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_ytdlp.media 17 | abx_plugin_ytdlp.config 18 | abx_plugin_ytdlp.binaries 19 | ``` 20 | 21 | ## Package Contents 22 | 23 | ### Functions 24 | 25 | ````{list-table} 26 | :class: autosummary longtable 27 | :align: left 28 | 29 | * - {py:obj}`get_CONFIG ` 30 | - ```{autodoc2-docstring} abx_plugin_ytdlp.get_CONFIG 31 | :summary: 32 | ``` 33 | * - {py:obj}`get_BINARIES ` 34 | - ```{autodoc2-docstring} abx_plugin_ytdlp.get_BINARIES 35 | :summary: 36 | ``` 37 | * - {py:obj}`ready ` 38 | - ```{autodoc2-docstring} abx_plugin_ytdlp.ready 39 | :summary: 40 | ``` 41 | ```` 42 | 43 | ### Data 44 | 45 | ````{list-table} 46 | :class: autosummary longtable 47 | :align: left 48 | 49 | * - {py:obj}`__label__ ` 50 | - ```{autodoc2-docstring} abx_plugin_ytdlp.__label__ 51 | :summary: 52 | ``` 53 | * - {py:obj}`__homepage__ ` 54 | - ```{autodoc2-docstring} abx_plugin_ytdlp.__homepage__ 55 | :summary: 56 | ``` 57 | ```` 58 | 59 | ### API 60 | 61 | ````{py:data} __label__ 62 | :canonical: abx_plugin_ytdlp.__label__ 63 | :value: > 64 | 'YT-DLP' 65 | 66 | ```{autodoc2-docstring} abx_plugin_ytdlp.__label__ 67 | ``` 68 | 69 | ```` 70 | 71 | ````{py:data} __homepage__ 72 | :canonical: abx_plugin_ytdlp.__homepage__ 73 | :value: > 74 | 'https://github.com/yt-dlp/yt-dlp' 75 | 76 | ```{autodoc2-docstring} abx_plugin_ytdlp.__homepage__ 77 | ``` 78 | 79 | ```` 80 | 81 | ````{py:function} get_CONFIG() 82 | :canonical: abx_plugin_ytdlp.get_CONFIG 83 | 84 | ```{autodoc2-docstring} abx_plugin_ytdlp.get_CONFIG 85 | ``` 86 | ```` 87 | 88 | ````{py:function} get_BINARIES() 89 | :canonical: abx_plugin_ytdlp.get_BINARIES 90 | 91 | ```{autodoc2-docstring} abx_plugin_ytdlp.get_BINARIES 92 | ``` 93 | ```` 94 | 95 | ````{py:function} ready() 96 | :canonical: abx_plugin_ytdlp.ready 97 | 98 | ```{autodoc2-docstring} abx_plugin_ytdlp.ready 99 | ``` 100 | ```` 101 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_readability/abx_plugin_readability.extractors.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_readability.extractors` 2 | 3 | ```{py:module} abx_plugin_readability.extractors 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_readability.extractors 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ReadabilityExtractor ` 19 | - ```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`READABILITY_EXTRACTOR ` 31 | - ```{autodoc2-docstring} abx_plugin_readability.extractors.READABILITY_EXTRACTOR 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | `````{py:class} ReadabilityExtractor 39 | :canonical: abx_plugin_readability.extractors.ReadabilityExtractor 40 | 41 | Bases: {py:obj}`abx_spec_extractor.BaseExtractor` 42 | 43 | ```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor 44 | ``` 45 | 46 | ````{py:attribute} name 47 | :canonical: abx_plugin_readability.extractors.ReadabilityExtractor.name 48 | :type: abx_spec_extractor.ExtractorName 49 | :value: > 50 | 'readability' 51 | 52 | ```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor.name 53 | ``` 54 | 55 | ```` 56 | 57 | ````{py:attribute} binary 58 | :canonical: abx_plugin_readability.extractors.ReadabilityExtractor.binary 59 | :type: abx_pkg.BinName 60 | :value: > 61 | None 62 | 63 | ```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor.binary 64 | ``` 65 | 66 | ```` 67 | 68 | ````{py:method} get_output_path(snapshot) -> pathlib.Path 69 | :canonical: abx_plugin_readability.extractors.ReadabilityExtractor.get_output_path 70 | 71 | ```{autodoc2-docstring} abx_plugin_readability.extractors.ReadabilityExtractor.get_output_path 72 | ``` 73 | 74 | ```` 75 | 76 | ````` 77 | 78 | ````{py:data} READABILITY_EXTRACTOR 79 | :canonical: abx_plugin_readability.extractors.READABILITY_EXTRACTOR 80 | :value: > 81 | 'ReadabilityExtractor(...)' 82 | 83 | ```{autodoc2-docstring} abx_plugin_readability.extractors.READABILITY_EXTRACTOR 84 | ``` 85 | 86 | ```` 87 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.queues.tasks.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.queues.tasks` 2 | 3 | ```{py:module} archivebox.queues.tasks 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.queues.tasks 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`db_task_with_parent ` 19 | - ```{autodoc2-docstring} archivebox.queues.tasks.db_task_with_parent 20 | :summary: 21 | ``` 22 | * - {py:obj}`bg_add ` 23 | - ```{autodoc2-docstring} archivebox.queues.tasks.bg_add 24 | :summary: 25 | ``` 26 | * - {py:obj}`bg_archive_links ` 27 | - ```{autodoc2-docstring} archivebox.queues.tasks.bg_archive_links 28 | :summary: 29 | ``` 30 | * - {py:obj}`bg_archive_link ` 31 | - ```{autodoc2-docstring} archivebox.queues.tasks.bg_archive_link 32 | :summary: 33 | ``` 34 | * - {py:obj}`bg_archive_snapshot ` 35 | - ```{autodoc2-docstring} archivebox.queues.tasks.bg_archive_snapshot 36 | :summary: 37 | ``` 38 | ```` 39 | 40 | ### API 41 | 42 | ````{py:function} db_task_with_parent(func) 43 | :canonical: archivebox.queues.tasks.db_task_with_parent 44 | 45 | ```{autodoc2-docstring} archivebox.queues.tasks.db_task_with_parent 46 | ``` 47 | ```` 48 | 49 | ````{py:function} bg_add(add_kwargs, task=None, parent_task_id=None) 50 | :canonical: archivebox.queues.tasks.bg_add 51 | 52 | ```{autodoc2-docstring} archivebox.queues.tasks.bg_add 53 | ``` 54 | ```` 55 | 56 | ````{py:function} bg_archive_links(args, kwargs=None, task=None, parent_task_id=None) 57 | :canonical: archivebox.queues.tasks.bg_archive_links 58 | 59 | ```{autodoc2-docstring} archivebox.queues.tasks.bg_archive_links 60 | ``` 61 | ```` 62 | 63 | ````{py:function} bg_archive_link(args, kwargs=None, task=None, parent_task_id=None) 64 | :canonical: archivebox.queues.tasks.bg_archive_link 65 | 66 | ```{autodoc2-docstring} archivebox.queues.tasks.bg_archive_link 67 | ``` 68 | ```` 69 | 70 | ````{py:function} bg_archive_snapshot(snapshot, overwrite=False, methods=None, task=None, parent_task_id=None) 71 | :canonical: archivebox.queues.tasks.bg_archive_snapshot 72 | 73 | ```{autodoc2-docstring} archivebox.queues.tasks.bg_archive_snapshot 74 | ``` 75 | ```` 76 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.url_list.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.url_list` 2 | 3 | ```{py:module} archivebox.parsers.url_list 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.url_list 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_url_list ` 19 | - ```{autodoc2-docstring} archivebox.parsers.url_list.parse_url_list 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__description__ ` 31 | - ```{autodoc2-docstring} archivebox.parsers.url_list.__description__ 32 | :summary: 33 | ``` 34 | * - {py:obj}`KEY ` 35 | - ```{autodoc2-docstring} archivebox.parsers.url_list.KEY 36 | :summary: 37 | ``` 38 | * - {py:obj}`NAME ` 39 | - ```{autodoc2-docstring} archivebox.parsers.url_list.NAME 40 | :summary: 41 | ``` 42 | * - {py:obj}`PARSER ` 43 | - ```{autodoc2-docstring} archivebox.parsers.url_list.PARSER 44 | :summary: 45 | ``` 46 | ```` 47 | 48 | ### API 49 | 50 | ````{py:data} __description__ 51 | :canonical: archivebox.parsers.url_list.__description__ 52 | :value: > 53 | 'URL list' 54 | 55 | ```{autodoc2-docstring} archivebox.parsers.url_list.__description__ 56 | ``` 57 | 58 | ```` 59 | 60 | ````{py:function} parse_url_list(text_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 61 | :canonical: archivebox.parsers.url_list.parse_url_list 62 | 63 | ```{autodoc2-docstring} archivebox.parsers.url_list.parse_url_list 64 | ``` 65 | ```` 66 | 67 | ````{py:data} KEY 68 | :canonical: archivebox.parsers.url_list.KEY 69 | :value: > 70 | 'url_list' 71 | 72 | ```{autodoc2-docstring} archivebox.parsers.url_list.KEY 73 | ``` 74 | 75 | ```` 76 | 77 | ````{py:data} NAME 78 | :canonical: archivebox.parsers.url_list.NAME 79 | :value: > 80 | 'URL List' 81 | 82 | ```{autodoc2-docstring} archivebox.parsers.url_list.NAME 83 | ``` 84 | 85 | ```` 86 | 87 | ````{py:data} PARSER 88 | :canonical: archivebox.parsers.url_list.PARSER 89 | :value: > 90 | None 91 | 92 | ```{autodoc2-docstring} archivebox.parsers.url_list.PARSER 93 | ``` 94 | 95 | ```` 96 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.queues.semaphores.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.queues.semaphores` 2 | 3 | ```{py:module} archivebox.queues.semaphores 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.queues.semaphores 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`SqliteSemaphore ` 19 | - ```{autodoc2-docstring} archivebox.queues.semaphores.SqliteSemaphore 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Functions 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`lock_task_semaphore ` 31 | - ```{autodoc2-docstring} archivebox.queues.semaphores.lock_task_semaphore 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### Data 37 | 38 | ````{list-table} 39 | :class: autosummary longtable 40 | :align: left 41 | 42 | * - {py:obj}`LOCKS_DB_PATH ` 43 | - ```{autodoc2-docstring} archivebox.queues.semaphores.LOCKS_DB_PATH 44 | :summary: 45 | ``` 46 | ```` 47 | 48 | ### API 49 | 50 | `````{py:class} SqliteSemaphore(db_path, table_name, name, value=1, timeout=None) 51 | :canonical: archivebox.queues.semaphores.SqliteSemaphore 52 | 53 | ```{autodoc2-docstring} archivebox.queues.semaphores.SqliteSemaphore 54 | ``` 55 | 56 | ```{rubric} Initialization 57 | ``` 58 | 59 | ```{autodoc2-docstring} archivebox.queues.semaphores.SqliteSemaphore.__init__ 60 | ``` 61 | 62 | ````{py:method} acquire(name=None) 63 | :canonical: archivebox.queues.semaphores.SqliteSemaphore.acquire 64 | 65 | ```{autodoc2-docstring} archivebox.queues.semaphores.SqliteSemaphore.acquire 66 | ``` 67 | 68 | ```` 69 | 70 | ````{py:method} release(name) 71 | :canonical: archivebox.queues.semaphores.SqliteSemaphore.release 72 | 73 | ```{autodoc2-docstring} archivebox.queues.semaphores.SqliteSemaphore.release 74 | ``` 75 | 76 | ```` 77 | 78 | ````` 79 | 80 | ````{py:data} LOCKS_DB_PATH 81 | :canonical: archivebox.queues.semaphores.LOCKS_DB_PATH 82 | :value: > 83 | None 84 | 85 | ```{autodoc2-docstring} archivebox.queues.semaphores.LOCKS_DB_PATH 86 | ``` 87 | 88 | ```` 89 | 90 | ````{py:function} lock_task_semaphore(db_path, table_name, lock_name, value=1, timeout=None) 91 | :canonical: archivebox.queues.semaphores.lock_task_semaphore 92 | 93 | ```{autodoc2-docstring} archivebox.queues.semaphores.lock_task_semaphore 94 | ``` 95 | ```` 96 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_mercury/abx_plugin_mercury.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_mercury` 2 | 3 | ```{py:module} abx_plugin_mercury 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_mercury 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_mercury.config 17 | abx_plugin_mercury.extractors 18 | abx_plugin_mercury.binaries 19 | abx_plugin_mercury.mercury 20 | ``` 21 | 22 | ## Package Contents 23 | 24 | ### Functions 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`get_CONFIG ` 31 | - ```{autodoc2-docstring} abx_plugin_mercury.get_CONFIG 32 | :summary: 33 | ``` 34 | * - {py:obj}`get_BINARIES ` 35 | - ```{autodoc2-docstring} abx_plugin_mercury.get_BINARIES 36 | :summary: 37 | ``` 38 | * - {py:obj}`get_EXTRACTORS ` 39 | - ```{autodoc2-docstring} abx_plugin_mercury.get_EXTRACTORS 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### Data 45 | 46 | ````{list-table} 47 | :class: autosummary longtable 48 | :align: left 49 | 50 | * - {py:obj}`__label__ ` 51 | - ```{autodoc2-docstring} abx_plugin_mercury.__label__ 52 | :summary: 53 | ``` 54 | * - {py:obj}`__homepage__ ` 55 | - ```{autodoc2-docstring} abx_plugin_mercury.__homepage__ 56 | :summary: 57 | ``` 58 | ```` 59 | 60 | ### API 61 | 62 | ````{py:data} __label__ 63 | :canonical: abx_plugin_mercury.__label__ 64 | :value: > 65 | 'Postlight Parser' 66 | 67 | ```{autodoc2-docstring} abx_plugin_mercury.__label__ 68 | ``` 69 | 70 | ```` 71 | 72 | ````{py:data} __homepage__ 73 | :canonical: abx_plugin_mercury.__homepage__ 74 | :value: > 75 | 'https://github.com/postlight/mercury-parser' 76 | 77 | ```{autodoc2-docstring} abx_plugin_mercury.__homepage__ 78 | ``` 79 | 80 | ```` 81 | 82 | ````{py:function} get_CONFIG() 83 | :canonical: abx_plugin_mercury.get_CONFIG 84 | 85 | ```{autodoc2-docstring} abx_plugin_mercury.get_CONFIG 86 | ``` 87 | ```` 88 | 89 | ````{py:function} get_BINARIES() 90 | :canonical: abx_plugin_mercury.get_BINARIES 91 | 92 | ```{autodoc2-docstring} abx_plugin_mercury.get_BINARIES 93 | ``` 94 | ```` 95 | 96 | ````{py:function} get_EXTRACTORS() 97 | :canonical: abx_plugin_mercury.get_EXTRACTORS 98 | 99 | ```{autodoc2-docstring} abx_plugin_mercury.get_EXTRACTORS 100 | ``` 101 | ```` 102 | -------------------------------------------------------------------------------- /apidocs/abx_spec_archivebox/abx_spec_archivebox.events.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_spec_archivebox.events` 2 | 3 | ```{py:module} abx_spec_archivebox.events 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_spec_archivebox.events 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`on_crawl_schedule_tick ` 19 | - ```{autodoc2-docstring} abx_spec_archivebox.events.on_crawl_schedule_tick 20 | :summary: 21 | ``` 22 | * - {py:obj}`on_seed_post_save ` 23 | - ```{autodoc2-docstring} abx_spec_archivebox.events.on_seed_post_save 24 | :summary: 25 | ``` 26 | * - {py:obj}`on_crawl_post_save ` 27 | - ```{autodoc2-docstring} abx_spec_archivebox.events.on_crawl_post_save 28 | :summary: 29 | ``` 30 | * - {py:obj}`on_snapshot_post_save ` 31 | - ```{autodoc2-docstring} abx_spec_archivebox.events.on_snapshot_post_save 32 | :summary: 33 | ``` 34 | * - {py:obj}`on_archiveresult_post_save ` 35 | - ```{autodoc2-docstring} abx_spec_archivebox.events.on_archiveresult_post_save 36 | :summary: 37 | ``` 38 | ```` 39 | 40 | ### API 41 | 42 | ````{py:function} on_crawl_schedule_tick(crawl_schedule) 43 | :canonical: abx_spec_archivebox.events.on_crawl_schedule_tick 44 | 45 | ```{autodoc2-docstring} abx_spec_archivebox.events.on_crawl_schedule_tick 46 | ``` 47 | ```` 48 | 49 | ````{py:function} on_seed_post_save(seed, created=False) 50 | :canonical: abx_spec_archivebox.events.on_seed_post_save 51 | 52 | ```{autodoc2-docstring} abx_spec_archivebox.events.on_seed_post_save 53 | ``` 54 | ```` 55 | 56 | ````{py:function} on_crawl_post_save(crawl, created=False) 57 | :canonical: abx_spec_archivebox.events.on_crawl_post_save 58 | 59 | ```{autodoc2-docstring} abx_spec_archivebox.events.on_crawl_post_save 60 | ``` 61 | ```` 62 | 63 | ````{py:function} on_snapshot_post_save(snapshot, created=False) 64 | :canonical: abx_spec_archivebox.events.on_snapshot_post_save 65 | 66 | ```{autodoc2-docstring} abx_spec_archivebox.events.on_snapshot_post_save 67 | ``` 68 | ```` 69 | 70 | ````{py:function} on_archiveresult_post_save(archiveresult, created=False) 71 | :canonical: abx_spec_archivebox.events.on_archiveresult_post_save 72 | 73 | ```{autodoc2-docstring} abx_spec_archivebox.events.on_archiveresult_post_save 74 | ``` 75 | ```` 76 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.generic_txt.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.generic_txt` 2 | 3 | ```{py:module} archivebox.parsers.generic_txt 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.generic_txt 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_generic_txt_export ` 19 | - ```{autodoc2-docstring} archivebox.parsers.generic_txt.parse_generic_txt_export 20 | :summary: 21 | ``` 22 | ```` 23 | 24 | ### Data 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`__description__ ` 31 | - ```{autodoc2-docstring} archivebox.parsers.generic_txt.__description__ 32 | :summary: 33 | ``` 34 | * - {py:obj}`KEY ` 35 | - ```{autodoc2-docstring} archivebox.parsers.generic_txt.KEY 36 | :summary: 37 | ``` 38 | * - {py:obj}`NAME ` 39 | - ```{autodoc2-docstring} archivebox.parsers.generic_txt.NAME 40 | :summary: 41 | ``` 42 | * - {py:obj}`PARSER ` 43 | - ```{autodoc2-docstring} archivebox.parsers.generic_txt.PARSER 44 | :summary: 45 | ``` 46 | ```` 47 | 48 | ### API 49 | 50 | ````{py:data} __description__ 51 | :canonical: archivebox.parsers.generic_txt.__description__ 52 | :value: > 53 | 'Plain Text' 54 | 55 | ```{autodoc2-docstring} archivebox.parsers.generic_txt.__description__ 56 | ``` 57 | 58 | ```` 59 | 60 | ````{py:function} parse_generic_txt_export(text_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 61 | :canonical: archivebox.parsers.generic_txt.parse_generic_txt_export 62 | 63 | ```{autodoc2-docstring} archivebox.parsers.generic_txt.parse_generic_txt_export 64 | ``` 65 | ```` 66 | 67 | ````{py:data} KEY 68 | :canonical: archivebox.parsers.generic_txt.KEY 69 | :value: > 70 | 'txt' 71 | 72 | ```{autodoc2-docstring} archivebox.parsers.generic_txt.KEY 73 | ``` 74 | 75 | ```` 76 | 77 | ````{py:data} NAME 78 | :canonical: archivebox.parsers.generic_txt.NAME 79 | :value: > 80 | 'Generic TXT' 81 | 82 | ```{autodoc2-docstring} archivebox.parsers.generic_txt.NAME 83 | ``` 84 | 85 | ```` 86 | 87 | ````{py:data} PARSER 88 | :canonical: archivebox.parsers.generic_txt.PARSER 89 | :value: > 90 | None 91 | 92 | ```{autodoc2-docstring} archivebox.parsers.generic_txt.PARSER 93 | ``` 94 | 95 | ```` 96 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_puppeteer/abx_plugin_puppeteer.config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_puppeteer.config` 2 | 3 | ```{py:module} abx_plugin_puppeteer.config 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_puppeteer.config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`PuppeteerConfig ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`PUPPETEER_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_puppeteer.config.PUPPETEER_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} PuppeteerConfig(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any) 37 | :canonical: abx_plugin_puppeteer.config.PuppeteerConfig 38 | 39 | Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet` 40 | 41 | ````{py:attribute} PUPPETEER_BINARY 42 | :canonical: abx_plugin_puppeteer.config.PuppeteerConfig.PUPPETEER_BINARY 43 | :type: str 44 | :value: > 45 | 'puppeteer' 46 | 47 | ```{autodoc2-docstring} abx_plugin_puppeteer.config.PuppeteerConfig.PUPPETEER_BINARY 48 | ``` 49 | 50 | ```` 51 | 52 | ````` 53 | 54 | ````{py:data} PUPPETEER_CONFIG 55 | :canonical: abx_plugin_puppeteer.config.PUPPETEER_CONFIG 56 | :value: > 57 | 'PuppeteerConfig(...)' 58 | 59 | ```{autodoc2-docstring} abx_plugin_puppeteer.config.PUPPETEER_CONFIG 60 | ``` 61 | 62 | ```` 63 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_puppeteer/abx_plugin_puppeteer.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_puppeteer` 2 | 3 | ```{py:module} abx_plugin_puppeteer 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_puppeteer 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_puppeteer.config 17 | abx_plugin_puppeteer.binaries 18 | abx_plugin_puppeteer.binproviders 19 | ``` 20 | 21 | ## Package Contents 22 | 23 | ### Functions 24 | 25 | ````{list-table} 26 | :class: autosummary longtable 27 | :align: left 28 | 29 | * - {py:obj}`get_CONFIG ` 30 | - ```{autodoc2-docstring} abx_plugin_puppeteer.get_CONFIG 31 | :summary: 32 | ``` 33 | * - {py:obj}`get_BINARIES ` 34 | - ```{autodoc2-docstring} abx_plugin_puppeteer.get_BINARIES 35 | :summary: 36 | ``` 37 | * - {py:obj}`get_BINPROVIDERS ` 38 | - ```{autodoc2-docstring} abx_plugin_puppeteer.get_BINPROVIDERS 39 | :summary: 40 | ``` 41 | ```` 42 | 43 | ### Data 44 | 45 | ````{list-table} 46 | :class: autosummary longtable 47 | :align: left 48 | 49 | * - {py:obj}`__label__ ` 50 | - ```{autodoc2-docstring} abx_plugin_puppeteer.__label__ 51 | :summary: 52 | ``` 53 | * - {py:obj}`__homepage__ ` 54 | - ```{autodoc2-docstring} abx_plugin_puppeteer.__homepage__ 55 | :summary: 56 | ``` 57 | ```` 58 | 59 | ### API 60 | 61 | ````{py:data} __label__ 62 | :canonical: abx_plugin_puppeteer.__label__ 63 | :value: > 64 | 'Puppeteer' 65 | 66 | ```{autodoc2-docstring} abx_plugin_puppeteer.__label__ 67 | ``` 68 | 69 | ```` 70 | 71 | ````{py:data} __homepage__ 72 | :canonical: abx_plugin_puppeteer.__homepage__ 73 | :value: > 74 | 'https://github.com/puppeteer/puppeteer' 75 | 76 | ```{autodoc2-docstring} abx_plugin_puppeteer.__homepage__ 77 | ``` 78 | 79 | ```` 80 | 81 | ````{py:function} get_CONFIG() 82 | :canonical: abx_plugin_puppeteer.get_CONFIG 83 | 84 | ```{autodoc2-docstring} abx_plugin_puppeteer.get_CONFIG 85 | ``` 86 | ```` 87 | 88 | ````{py:function} get_BINARIES() 89 | :canonical: abx_plugin_puppeteer.get_BINARIES 90 | 91 | ```{autodoc2-docstring} abx_plugin_puppeteer.get_BINARIES 92 | ``` 93 | ```` 94 | 95 | ````{py:function} get_BINPROVIDERS() 96 | :canonical: abx_plugin_puppeteer.get_BINPROVIDERS 97 | 98 | ```{autodoc2-docstring} abx_plugin_puppeteer.get_BINPROVIDERS 99 | ``` 100 | ```` 101 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.generic_jsonl.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.generic_jsonl` 2 | 3 | ```{py:module} archivebox.parsers.generic_jsonl 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.generic_jsonl 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`parse_line ` 19 | - ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.parse_line 20 | :summary: 21 | ``` 22 | * - {py:obj}`parse_generic_jsonl_export ` 23 | - ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.parse_generic_jsonl_export 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### Data 29 | 30 | ````{list-table} 31 | :class: autosummary longtable 32 | :align: left 33 | 34 | * - {py:obj}`KEY ` 35 | - ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.KEY 36 | :summary: 37 | ``` 38 | * - {py:obj}`NAME ` 39 | - ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.NAME 40 | :summary: 41 | ``` 42 | * - {py:obj}`PARSER ` 43 | - ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.PARSER 44 | :summary: 45 | ``` 46 | ```` 47 | 48 | ### API 49 | 50 | ````{py:function} parse_line(line: str) 51 | :canonical: archivebox.parsers.generic_jsonl.parse_line 52 | 53 | ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.parse_line 54 | ``` 55 | ```` 56 | 57 | ````{py:function} parse_generic_jsonl_export(json_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 58 | :canonical: archivebox.parsers.generic_jsonl.parse_generic_jsonl_export 59 | 60 | ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.parse_generic_jsonl_export 61 | ``` 62 | ```` 63 | 64 | ````{py:data} KEY 65 | :canonical: archivebox.parsers.generic_jsonl.KEY 66 | :value: > 67 | 'jsonl' 68 | 69 | ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.KEY 70 | ``` 71 | 72 | ```` 73 | 74 | ````{py:data} NAME 75 | :canonical: archivebox.parsers.generic_jsonl.NAME 76 | :value: > 77 | 'Generic JSONL' 78 | 79 | ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.NAME 80 | ``` 81 | 82 | ```` 83 | 84 | ````{py:data} PARSER 85 | :canonical: archivebox.parsers.generic_jsonl.PARSER 86 | :value: > 87 | None 88 | 89 | ```{autodoc2-docstring} archivebox.parsers.generic_jsonl.PARSER 90 | ``` 91 | 92 | ```` 93 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_htmltotext/abx_plugin_htmltotext.config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_htmltotext.config` 2 | 3 | ```{py:module} abx_plugin_htmltotext.config 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_htmltotext.config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`HtmltotextConfig ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`HTMLTOTEXT_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_htmltotext.config.HTMLTOTEXT_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} HtmltotextConfig(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any) 37 | :canonical: abx_plugin_htmltotext.config.HtmltotextConfig 38 | 39 | Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet` 40 | 41 | ````{py:attribute} SAVE_HTMLTOTEXT 42 | :canonical: abx_plugin_htmltotext.config.HtmltotextConfig.SAVE_HTMLTOTEXT 43 | :type: bool 44 | :value: > 45 | True 46 | 47 | ```{autodoc2-docstring} abx_plugin_htmltotext.config.HtmltotextConfig.SAVE_HTMLTOTEXT 48 | ``` 49 | 50 | ```` 51 | 52 | ````` 53 | 54 | ````{py:data} HTMLTOTEXT_CONFIG 55 | :canonical: abx_plugin_htmltotext.config.HTMLTOTEXT_CONFIG 56 | :value: > 57 | 'HtmltotextConfig(...)' 58 | 59 | ```{autodoc2-docstring} abx_plugin_htmltotext.config.HTMLTOTEXT_CONFIG 60 | ``` 61 | 62 | ```` 63 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_playwright/abx_plugin_playwright.config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_playwright.config` 2 | 3 | ```{py:module} abx_plugin_playwright.config 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_playwright.config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`PlaywrightConfigs ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`PLAYWRIGHT_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_playwright.config.PLAYWRIGHT_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} PlaywrightConfigs(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any) 37 | :canonical: abx_plugin_playwright.config.PlaywrightConfigs 38 | 39 | Bases: {py:obj}`abx_spec_config.BaseConfigSet` 40 | 41 | ````{py:attribute} PLAYWRIGHT_BINARY 42 | :canonical: abx_plugin_playwright.config.PlaywrightConfigs.PLAYWRIGHT_BINARY 43 | :type: str 44 | :value: > 45 | 'playwright' 46 | 47 | ```{autodoc2-docstring} abx_plugin_playwright.config.PlaywrightConfigs.PLAYWRIGHT_BINARY 48 | ``` 49 | 50 | ```` 51 | 52 | ````` 53 | 54 | ````{py:data} PLAYWRIGHT_CONFIG 55 | :canonical: abx_plugin_playwright.config.PLAYWRIGHT_CONFIG 56 | :value: > 57 | 'PlaywrightConfigs(...)' 58 | 59 | ```{autodoc2-docstring} abx_plugin_playwright.config.PLAYWRIGHT_CONFIG 60 | ``` 61 | 62 | ```` 63 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.parsers.generic_json.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.parsers.generic_json` 2 | 3 | ```{py:module} archivebox.parsers.generic_json 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.parsers.generic_json 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`jsonObjectToLink ` 19 | - ```{autodoc2-docstring} archivebox.parsers.generic_json.jsonObjectToLink 20 | :summary: 21 | ``` 22 | * - {py:obj}`parse_generic_json_export ` 23 | - ```{autodoc2-docstring} archivebox.parsers.generic_json.parse_generic_json_export 24 | :summary: 25 | ``` 26 | ```` 27 | 28 | ### Data 29 | 30 | ````{list-table} 31 | :class: autosummary longtable 32 | :align: left 33 | 34 | * - {py:obj}`KEY ` 35 | - ```{autodoc2-docstring} archivebox.parsers.generic_json.KEY 36 | :summary: 37 | ``` 38 | * - {py:obj}`NAME ` 39 | - ```{autodoc2-docstring} archivebox.parsers.generic_json.NAME 40 | :summary: 41 | ``` 42 | * - {py:obj}`PARSER ` 43 | - ```{autodoc2-docstring} archivebox.parsers.generic_json.PARSER 44 | :summary: 45 | ``` 46 | ```` 47 | 48 | ### API 49 | 50 | ````{py:function} jsonObjectToLink(link: str, source: str) 51 | :canonical: archivebox.parsers.generic_json.jsonObjectToLink 52 | 53 | ```{autodoc2-docstring} archivebox.parsers.generic_json.jsonObjectToLink 54 | ``` 55 | ```` 56 | 57 | ````{py:function} parse_generic_json_export(json_file: typing.IO[str], **_kwargs) -> typing.Iterable[archivebox.index.schema.Link] 58 | :canonical: archivebox.parsers.generic_json.parse_generic_json_export 59 | 60 | ```{autodoc2-docstring} archivebox.parsers.generic_json.parse_generic_json_export 61 | ``` 62 | ```` 63 | 64 | ````{py:data} KEY 65 | :canonical: archivebox.parsers.generic_json.KEY 66 | :value: > 67 | 'json' 68 | 69 | ```{autodoc2-docstring} archivebox.parsers.generic_json.KEY 70 | ``` 71 | 72 | ```` 73 | 74 | ````{py:data} NAME 75 | :canonical: archivebox.parsers.generic_json.NAME 76 | :value: > 77 | 'Generic JSON' 78 | 79 | ```{autodoc2-docstring} archivebox.parsers.generic_json.NAME 80 | ``` 81 | 82 | ```` 83 | 84 | ````{py:data} PARSER 85 | :canonical: archivebox.parsers.generic_json.PARSER 86 | :value: > 87 | None 88 | 89 | ```{autodoc2-docstring} archivebox.parsers.generic_json.PARSER 90 | ``` 91 | 92 | ```` 93 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_playwright/abx_plugin_playwright.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_playwright` 2 | 3 | ```{py:module} abx_plugin_playwright 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_playwright 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_playwright.config 17 | abx_plugin_playwright.binaries 18 | abx_plugin_playwright.binproviders 19 | ``` 20 | 21 | ## Package Contents 22 | 23 | ### Functions 24 | 25 | ````{list-table} 26 | :class: autosummary longtable 27 | :align: left 28 | 29 | * - {py:obj}`get_CONFIG ` 30 | - ```{autodoc2-docstring} abx_plugin_playwright.get_CONFIG 31 | :summary: 32 | ``` 33 | * - {py:obj}`get_BINARIES ` 34 | - ```{autodoc2-docstring} abx_plugin_playwright.get_BINARIES 35 | :summary: 36 | ``` 37 | * - {py:obj}`get_BINPROVIDERS ` 38 | - ```{autodoc2-docstring} abx_plugin_playwright.get_BINPROVIDERS 39 | :summary: 40 | ``` 41 | ```` 42 | 43 | ### Data 44 | 45 | ````{list-table} 46 | :class: autosummary longtable 47 | :align: left 48 | 49 | * - {py:obj}`__label__ ` 50 | - ```{autodoc2-docstring} abx_plugin_playwright.__label__ 51 | :summary: 52 | ``` 53 | * - {py:obj}`__homepage__ ` 54 | - ```{autodoc2-docstring} abx_plugin_playwright.__homepage__ 55 | :summary: 56 | ``` 57 | ```` 58 | 59 | ### API 60 | 61 | ````{py:data} __label__ 62 | :canonical: abx_plugin_playwright.__label__ 63 | :value: > 64 | 'Playwright' 65 | 66 | ```{autodoc2-docstring} abx_plugin_playwright.__label__ 67 | ``` 68 | 69 | ```` 70 | 71 | ````{py:data} __homepage__ 72 | :canonical: abx_plugin_playwright.__homepage__ 73 | :value: > 74 | 'https://github.com/microsoft/playwright-python' 75 | 76 | ```{autodoc2-docstring} abx_plugin_playwright.__homepage__ 77 | ``` 78 | 79 | ```` 80 | 81 | ````{py:function} get_CONFIG() 82 | :canonical: abx_plugin_playwright.get_CONFIG 83 | 84 | ```{autodoc2-docstring} abx_plugin_playwright.get_CONFIG 85 | ``` 86 | ```` 87 | 88 | ````{py:function} get_BINARIES() 89 | :canonical: abx_plugin_playwright.get_BINARIES 90 | 91 | ```{autodoc2-docstring} abx_plugin_playwright.get_BINARIES 92 | ``` 93 | ```` 94 | 95 | ````{py:function} get_BINPROVIDERS() 96 | :canonical: abx_plugin_playwright.get_BINPROVIDERS 97 | 98 | ```{autodoc2-docstring} abx_plugin_playwright.get_BINPROVIDERS 99 | ``` 100 | ```` 101 | -------------------------------------------------------------------------------- /apidocs/archivebox/archivebox.core.middleware.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`archivebox.core.middleware` 2 | 3 | ```{py:module} archivebox.core.middleware 4 | ``` 5 | 6 | ```{autodoc2-docstring} archivebox.core.middleware 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ReverseProxyAuthMiddleware ` 19 | - 20 | ```` 21 | 22 | ### Functions 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`detect_timezone ` 29 | - ```{autodoc2-docstring} archivebox.core.middleware.detect_timezone 30 | :summary: 31 | ``` 32 | * - {py:obj}`TimezoneMiddleware ` 33 | - ```{autodoc2-docstring} archivebox.core.middleware.TimezoneMiddleware 34 | :summary: 35 | ``` 36 | * - {py:obj}`CacheControlMiddleware ` 37 | - ```{autodoc2-docstring} archivebox.core.middleware.CacheControlMiddleware 38 | :summary: 39 | ``` 40 | ```` 41 | 42 | ### API 43 | 44 | ````{py:function} detect_timezone(request, activate: bool = True) 45 | :canonical: archivebox.core.middleware.detect_timezone 46 | 47 | ```{autodoc2-docstring} archivebox.core.middleware.detect_timezone 48 | ``` 49 | ```` 50 | 51 | ````{py:function} TimezoneMiddleware(get_response) 52 | :canonical: archivebox.core.middleware.TimezoneMiddleware 53 | 54 | ```{autodoc2-docstring} archivebox.core.middleware.TimezoneMiddleware 55 | ``` 56 | ```` 57 | 58 | ````{py:function} CacheControlMiddleware(get_response) 59 | :canonical: archivebox.core.middleware.CacheControlMiddleware 60 | 61 | ```{autodoc2-docstring} archivebox.core.middleware.CacheControlMiddleware 62 | ``` 63 | ```` 64 | 65 | `````{py:class} ReverseProxyAuthMiddleware(get_response) 66 | :canonical: archivebox.core.middleware.ReverseProxyAuthMiddleware 67 | 68 | Bases: {py:obj}`django.contrib.auth.middleware.RemoteUserMiddleware` 69 | 70 | ````{py:attribute} header 71 | :canonical: archivebox.core.middleware.ReverseProxyAuthMiddleware.header 72 | :value: > 73 | 'format(...)' 74 | 75 | ```{autodoc2-docstring} archivebox.core.middleware.ReverseProxyAuthMiddleware.header 76 | ``` 77 | 78 | ```` 79 | 80 | ````{py:method} process_request(request) 81 | :canonical: archivebox.core.middleware.ReverseProxyAuthMiddleware.process_request 82 | 83 | ```{autodoc2-docstring} archivebox.core.middleware.ReverseProxyAuthMiddleware.process_request 84 | ``` 85 | 86 | ```` 87 | 88 | ````` 89 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_archivedotorg/abx_plugin_archivedotorg.archive_org.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_archivedotorg.archive_org` 2 | 3 | ```{py:module} abx_plugin_archivedotorg.archive_org 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`should_save_archive_dot_org ` 23 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.should_save_archive_dot_org 24 | :summary: 25 | ``` 26 | * - {py:obj}`save_archive_dot_org ` 27 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.save_archive_dot_org 28 | :summary: 29 | ``` 30 | * - {py:obj}`parse_archive_dot_org_response ` 31 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.parse_archive_dot_org_response 32 | :summary: 33 | ``` 34 | ```` 35 | 36 | ### API 37 | 38 | ````{py:function} get_output_path() 39 | :canonical: abx_plugin_archivedotorg.archive_org.get_output_path 40 | 41 | ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.get_output_path 42 | ``` 43 | ```` 44 | 45 | ````{py:function} should_save_archive_dot_org(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, overwrite: typing.Optional[bool] = False) -> bool 46 | :canonical: abx_plugin_archivedotorg.archive_org.should_save_archive_dot_org 47 | 48 | ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.should_save_archive_dot_org 49 | ``` 50 | ```` 51 | 52 | ````{py:function} save_archive_dot_org(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = CURL_CONFIG.CURL_TIMEOUT) -> archivebox.index.schema.ArchiveResult 53 | :canonical: abx_plugin_archivedotorg.archive_org.save_archive_dot_org 54 | 55 | ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.save_archive_dot_org 56 | ``` 57 | ```` 58 | 59 | ````{py:function} parse_archive_dot_org_response(response: str) -> typing.Tuple[typing.List[str], typing.List[str]] 60 | :canonical: abx_plugin_archivedotorg.archive_org.parse_archive_dot_org_response 61 | 62 | ```{autodoc2-docstring} abx_plugin_archivedotorg.archive_org.parse_archive_dot_org_response 63 | ``` 64 | ```` 65 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_readability/abx_plugin_readability.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_readability` 2 | 3 | ```{py:module} abx_plugin_readability 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_readability 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_readability.config 17 | abx_plugin_readability.readability 18 | abx_plugin_readability.extractors 19 | abx_plugin_readability.binaries 20 | ``` 21 | 22 | ## Package Contents 23 | 24 | ### Functions 25 | 26 | ````{list-table} 27 | :class: autosummary longtable 28 | :align: left 29 | 30 | * - {py:obj}`get_CONFIG ` 31 | - ```{autodoc2-docstring} abx_plugin_readability.get_CONFIG 32 | :summary: 33 | ``` 34 | * - {py:obj}`get_BINARIES ` 35 | - ```{autodoc2-docstring} abx_plugin_readability.get_BINARIES 36 | :summary: 37 | ``` 38 | * - {py:obj}`get_EXTRACTORS ` 39 | - ```{autodoc2-docstring} abx_plugin_readability.get_EXTRACTORS 40 | :summary: 41 | ``` 42 | ```` 43 | 44 | ### Data 45 | 46 | ````{list-table} 47 | :class: autosummary longtable 48 | :align: left 49 | 50 | * - {py:obj}`__label__ ` 51 | - ```{autodoc2-docstring} abx_plugin_readability.__label__ 52 | :summary: 53 | ``` 54 | * - {py:obj}`__homepage__ ` 55 | - ```{autodoc2-docstring} abx_plugin_readability.__homepage__ 56 | :summary: 57 | ``` 58 | ```` 59 | 60 | ### API 61 | 62 | ````{py:data} __label__ 63 | :canonical: abx_plugin_readability.__label__ 64 | :value: > 65 | 'Readability' 66 | 67 | ```{autodoc2-docstring} abx_plugin_readability.__label__ 68 | ``` 69 | 70 | ```` 71 | 72 | ````{py:data} __homepage__ 73 | :canonical: abx_plugin_readability.__homepage__ 74 | :value: > 75 | 'https://github.com/ArchiveBox/readability-extractor' 76 | 77 | ```{autodoc2-docstring} abx_plugin_readability.__homepage__ 78 | ``` 79 | 80 | ```` 81 | 82 | ````{py:function} get_CONFIG() 83 | :canonical: abx_plugin_readability.get_CONFIG 84 | 85 | ```{autodoc2-docstring} abx_plugin_readability.get_CONFIG 86 | ``` 87 | ```` 88 | 89 | ````{py:function} get_BINARIES() 90 | :canonical: abx_plugin_readability.get_BINARIES 91 | 92 | ```{autodoc2-docstring} abx_plugin_readability.get_BINARIES 93 | ``` 94 | ```` 95 | 96 | ````{py:function} get_EXTRACTORS() 97 | :canonical: abx_plugin_readability.get_EXTRACTORS 98 | 99 | ```{autodoc2-docstring} abx_plugin_readability.get_EXTRACTORS 100 | ``` 101 | ```` 102 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_mercury/abx_plugin_mercury.mercury.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_mercury.mercury` 2 | 3 | ```{py:module} abx_plugin_mercury.mercury 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_mercury.mercury 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Functions 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`get_output_path ` 19 | - ```{autodoc2-docstring} abx_plugin_mercury.mercury.get_output_path 20 | :summary: 21 | ``` 22 | * - {py:obj}`get_embed_path ` 23 | - ```{autodoc2-docstring} abx_plugin_mercury.mercury.get_embed_path 24 | :summary: 25 | ``` 26 | * - {py:obj}`ShellError ` 27 | - ```{autodoc2-docstring} abx_plugin_mercury.mercury.ShellError 28 | :summary: 29 | ``` 30 | * - {py:obj}`should_save_mercury ` 31 | - ```{autodoc2-docstring} abx_plugin_mercury.mercury.should_save_mercury 32 | :summary: 33 | ``` 34 | * - {py:obj}`save_mercury ` 35 | - ```{autodoc2-docstring} abx_plugin_mercury.mercury.save_mercury 36 | :summary: 37 | ``` 38 | ```` 39 | 40 | ### API 41 | 42 | ````{py:function} get_output_path() 43 | :canonical: abx_plugin_mercury.mercury.get_output_path 44 | 45 | ```{autodoc2-docstring} abx_plugin_mercury.mercury.get_output_path 46 | ``` 47 | ```` 48 | 49 | ````{py:function} get_embed_path(archiveresult=None) 50 | :canonical: abx_plugin_mercury.mercury.get_embed_path 51 | 52 | ```{autodoc2-docstring} abx_plugin_mercury.mercury.get_embed_path 53 | ``` 54 | ```` 55 | 56 | ````{py:function} ShellError(cmd: typing.List[str], result: subprocess.CompletedProcess, lines: int = 20) -> archivebox.index.schema.ArchiveError 57 | :canonical: abx_plugin_mercury.mercury.ShellError 58 | 59 | ```{autodoc2-docstring} abx_plugin_mercury.mercury.ShellError 60 | ``` 61 | ```` 62 | 63 | ````{py:function} should_save_mercury(link: archivebox.index.schema.Link, out_dir: typing.Optional[str] = None, overwrite: typing.Optional[bool] = False) -> bool 64 | :canonical: abx_plugin_mercury.mercury.should_save_mercury 65 | 66 | ```{autodoc2-docstring} abx_plugin_mercury.mercury.should_save_mercury 67 | ``` 68 | ```` 69 | 70 | ````{py:function} save_mercury(link: archivebox.index.schema.Link, out_dir: typing.Optional[pathlib.Path] = None, timeout: int = MERCURY_CONFIG.MERCURY_TIMEOUT) -> archivebox.index.schema.ArchiveResult 71 | :canonical: abx_plugin_mercury.mercury.save_mercury 72 | 73 | ```{autodoc2-docstring} abx_plugin_mercury.mercury.save_mercury 74 | ``` 75 | ```` 76 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_archivedotorg/abx_plugin_archivedotorg.config.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_archivedotorg.config` 2 | 3 | ```{py:module} abx_plugin_archivedotorg.config 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_archivedotorg.config 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ArchivedotorgConfig ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`ARCHIVEDOTORG_CONFIG ` 29 | - ```{autodoc2-docstring} abx_plugin_archivedotorg.config.ARCHIVEDOTORG_CONFIG 30 | :summary: 31 | ``` 32 | ```` 33 | 34 | ### API 35 | 36 | `````{py:class} ArchivedotorgConfig(_case_sensitive: bool | None = None, _nested_model_default_partial_update: bool | None = None, _env_prefix: str | None = None, _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL, _env_file_encoding: str | None = None, _env_ignore_empty: bool | None = None, _env_nested_delimiter: str | None = None, _env_parse_none_str: str | None = None, _env_parse_enums: bool | None = None, _cli_prog_name: str | None = None, _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None, _cli_settings_source: pydantic_settings.sources.CliSettingsSource[typing.Any] | None = None, _cli_parse_none_str: str | None = None, _cli_hide_none_type: bool | None = None, _cli_avoid_json: bool | None = None, _cli_enforce_required: bool | None = None, _cli_use_class_docs_for_groups: bool | None = None, _cli_exit_on_error: bool | None = None, _cli_prefix: str | None = None, _cli_flag_prefix_char: str | None = None, _cli_implicit_flags: bool | None = None, _cli_ignore_unknown_args: bool | None = None, _secrets_dir: pydantic_settings.sources.PathType | None = None, **values: typing.Any) 37 | :canonical: abx_plugin_archivedotorg.config.ArchivedotorgConfig 38 | 39 | Bases: {py:obj}`abx_spec_config.base_configset.BaseConfigSet` 40 | 41 | ````{py:attribute} SAVE_ARCHIVE_DOT_ORG 42 | :canonical: abx_plugin_archivedotorg.config.ArchivedotorgConfig.SAVE_ARCHIVE_DOT_ORG 43 | :type: bool 44 | :value: > 45 | True 46 | 47 | ```{autodoc2-docstring} abx_plugin_archivedotorg.config.ArchivedotorgConfig.SAVE_ARCHIVE_DOT_ORG 48 | ``` 49 | 50 | ```` 51 | 52 | ````` 53 | 54 | ````{py:data} ARCHIVEDOTORG_CONFIG 55 | :canonical: abx_plugin_archivedotorg.config.ARCHIVEDOTORG_CONFIG 56 | :value: > 57 | 'ArchivedotorgConfig(...)' 58 | 59 | ```{autodoc2-docstring} abx_plugin_archivedotorg.config.ARCHIVEDOTORG_CONFIG 60 | ``` 61 | 62 | ```` 63 | -------------------------------------------------------------------------------- /Home.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | 4 | 5 |

ArchiveBox Documentation

6 | 7 |
8 | 9 | **📖 Use the sidebar on the right to browse documentation topics ➡️** 10 | 11 | (Expand the `Pages` section to 🔍 Search for a specific term) 12 | 13 |
14 | 15 | **📚 If you need help or have a question, you can:** 16 | - 💬 Chat with us on our [Public Zulip Server](https://zulip.archivebox.io) 17 | - 🐞 Open an [issue or feature request](https://github.com/ArchiveBox/ArchiveBox/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) in our bug tracker 18 | - 💠 Reach out to me on Twitter [@ArchiveBoxApp](https://twitter.com/ArchiveBoxApp) or [@theSquashSH](https://twitter.com/theSquashSH) 19 | 20 | --- 21 | 22 |
23 | 24 | CLI Screenshot 25 | Desktop index screenshot 26 | Desktop details page Screenshot
27 | 28 | Readme | Demo | Quickstart | Usage | Community 29 | 30 |
31 |
32 | 33 | **🏛️ [Contact us for professional support](https://docs.sweeting.me/s/archivebox-consulting-services) 💬** 34 | 35 |
36 | 37 | **✨ Or donate to support open-source development ✨** 38 | 39 | [![](https://img.shields.io/badge/Donate-Directly-%13DE5D26.svg)](https://hcb.hackclub.com/donations/start/archivebox) [![](https://img.shields.io/badge/Donate-Patreon-%23DD5D76.svg)](https://www.patreon.com/theSquashSH) [![](https://img.shields.io/badge/Donate-Github_Sponsors-%23B7CDFE.svg)](https://github.com/sponsors/pirate) 40 | 41 |
42 | ArchiveBox operates as a US 501(c)(3) nonprofit, donations are tax-deductible.
(fiscally sponsored by HCB EIN: 81-2908499)
43 |
44 | The name ArchiveBox™️ is trademarked in the US and you can find the ArchiveBox brand kit here. 45 |
46 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_readability/abx_plugin_readability.binaries.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_readability.binaries` 2 | 3 | ```{py:module} abx_plugin_readability.binaries 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_readability.binaries 7 | :allowtitles: 8 | ``` 9 | 10 | ## Module Contents 11 | 12 | ### Classes 13 | 14 | ````{list-table} 15 | :class: autosummary longtable 16 | :align: left 17 | 18 | * - {py:obj}`ReadabilityBinary ` 19 | - 20 | ```` 21 | 22 | ### Data 23 | 24 | ````{list-table} 25 | :class: autosummary longtable 26 | :align: left 27 | 28 | * - {py:obj}`READABILITY_PACKAGE_NAME ` 29 | - ```{autodoc2-docstring} abx_plugin_readability.binaries.READABILITY_PACKAGE_NAME 30 | :summary: 31 | ``` 32 | * - {py:obj}`READABILITY_BINARY ` 33 | - ```{autodoc2-docstring} abx_plugin_readability.binaries.READABILITY_BINARY 34 | :summary: 35 | ``` 36 | ```` 37 | 38 | ### API 39 | 40 | ````{py:data} READABILITY_PACKAGE_NAME 41 | :canonical: abx_plugin_readability.binaries.READABILITY_PACKAGE_NAME 42 | :value: > 43 | 'github:ArchiveBox/readability-extractor' 44 | 45 | ```{autodoc2-docstring} abx_plugin_readability.binaries.READABILITY_PACKAGE_NAME 46 | ``` 47 | 48 | ```` 49 | 50 | `````{py:class} ReadabilityBinary(/, **data: typing.Any) 51 | :canonical: abx_plugin_readability.binaries.ReadabilityBinary 52 | 53 | Bases: {py:obj}`abx_pkg.Binary` 54 | 55 | ````{py:attribute} name 56 | :canonical: abx_plugin_readability.binaries.ReadabilityBinary.name 57 | :type: abx_pkg.BinName 58 | :value: > 59 | None 60 | 61 | ```{autodoc2-docstring} abx_plugin_readability.binaries.ReadabilityBinary.name 62 | ``` 63 | 64 | ```` 65 | 66 | ````{py:attribute} binproviders_supported 67 | :canonical: abx_plugin_readability.binaries.ReadabilityBinary.binproviders_supported 68 | :type: typing.List[pydantic.InstanceOf[abx_pkg.BinProvider]] 69 | :value: > 70 | None 71 | 72 | ```{autodoc2-docstring} abx_plugin_readability.binaries.ReadabilityBinary.binproviders_supported 73 | ``` 74 | 75 | ```` 76 | 77 | ````{py:attribute} overrides 78 | :canonical: abx_plugin_readability.binaries.ReadabilityBinary.overrides 79 | :type: abx_pkg.BinaryOverrides 80 | :value: > 81 | None 82 | 83 | ```{autodoc2-docstring} abx_plugin_readability.binaries.ReadabilityBinary.overrides 84 | ``` 85 | 86 | ```` 87 | 88 | ````` 89 | 90 | ````{py:data} READABILITY_BINARY 91 | :canonical: abx_plugin_readability.binaries.READABILITY_BINARY 92 | :value: > 93 | 'ReadabilityBinary(...)' 94 | 95 | ```{autodoc2-docstring} abx_plugin_readability.binaries.READABILITY_BINARY 96 | ``` 97 | 98 | ```` 99 | -------------------------------------------------------------------------------- /apidocs/abx_plugin_ripgrep_search/abx_plugin_ripgrep_search.md: -------------------------------------------------------------------------------- 1 | # {py:mod}`abx_plugin_ripgrep_search` 2 | 3 | ```{py:module} abx_plugin_ripgrep_search 4 | ``` 5 | 6 | ```{autodoc2-docstring} abx_plugin_ripgrep_search 7 | :allowtitles: 8 | ``` 9 | 10 | ## Submodules 11 | 12 | ```{toctree} 13 | :titlesonly: 14 | :maxdepth: 1 15 | 16 | abx_plugin_ripgrep_search.searchbackend 17 | abx_plugin_ripgrep_search.config 18 | abx_plugin_ripgrep_search.binaries 19 | ``` 20 | 21 | ## Package Contents 22 | 23 | ### Functions 24 | 25 | ````{list-table} 26 | :class: autosummary longtable 27 | :align: left 28 | 29 | * - {py:obj}`get_CONFIG ` 30 | - ```{autodoc2-docstring} abx_plugin_ripgrep_search.get_CONFIG 31 | :summary: 32 | ``` 33 | * - {py:obj}`get_BINARIES ` 34 | - ```{autodoc2-docstring} abx_plugin_ripgrep_search.get_BINARIES 35 | :summary: 36 | ``` 37 | * - {py:obj}`get_SEARCHBACKENDS ` 38 | - ```{autodoc2-docstring} abx_plugin_ripgrep_search.get_SEARCHBACKENDS 39 | :summary: 40 | ``` 41 | ```` 42 | 43 | ### Data 44 | 45 | ````{list-table} 46 | :class: autosummary longtable 47 | :align: left 48 | 49 | * - {py:obj}`__label__ ` 50 | - ```{autodoc2-docstring} abx_plugin_ripgrep_search.__label__ 51 | :summary: 52 | ``` 53 | * - {py:obj}`__homepage__ ` 54 | - ```{autodoc2-docstring} abx_plugin_ripgrep_search.__homepage__ 55 | :summary: 56 | ``` 57 | ```` 58 | 59 | ### API 60 | 61 | ````{py:data} __label__ 62 | :canonical: abx_plugin_ripgrep_search.__label__ 63 | :value: > 64 | 'Ripgrep Search' 65 | 66 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.__label__ 67 | ``` 68 | 69 | ```` 70 | 71 | ````{py:data} __homepage__ 72 | :canonical: abx_plugin_ripgrep_search.__homepage__ 73 | :value: > 74 | 'https://github.com/BurntSushi/ripgrep' 75 | 76 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.__homepage__ 77 | ``` 78 | 79 | ```` 80 | 81 | ````{py:function} get_CONFIG() 82 | :canonical: abx_plugin_ripgrep_search.get_CONFIG 83 | 84 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.get_CONFIG 85 | ``` 86 | ```` 87 | 88 | ````{py:function} get_BINARIES() 89 | :canonical: abx_plugin_ripgrep_search.get_BINARIES 90 | 91 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.get_BINARIES 92 | ``` 93 | ```` 94 | 95 | ````{py:function} get_SEARCHBACKENDS() 96 | :canonical: abx_plugin_ripgrep_search.get_SEARCHBACKENDS 97 | 98 | ```{autodoc2-docstring} abx_plugin_ripgrep_search.get_SEARCHBACKENDS 99 | ``` 100 | ```` 101 | --------------------------------------------------------------------------------