The_Great_Archive/ArchiveBox
1
0
Fork 0
mirror of https://github.com/ArchiveBox/ArchiveBox.git synced 2026-09-14 11:06:13 +05:00
Code Issues Actions Packages Projects Releases Wiki Activity
5ec6478b12
ArchiveBox/docs/apidocs/archivebox/archivebox.config.collection.md
Nick Sweeting f4932430db
Some checks are pending
CodeQL / Analyze (${{ matrix.language }}) (none, python) (push) Waiting to run
Details
Build Debian package / build (amd64) (push) Waiting to run
Details
Build Debian package / build (arm64) (push) Waiting to run
Details
Build Debian package / test (amd64, ubuntu-24.04) (push) Blocked by required conditions
Details
Build Debian package / test (arm64, ubuntu-24.04-arm) (push) Blocked by required conditions
Details
Build Debian package / release (push) Blocked by required conditions
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-amd64, docker-amd64, linux/amd64, ubuntu-24.04) (push) Waiting to run
Details
Build Docker image / build ${{ matrix.platform }} (digest-linux-arm64, docker-arm64, linux/arm64, ubuntu-24.04-arm) (push) Waiting to run
Details
Build Docker image / publish multiarch tags (push) Blocked by required conditions
Details
Run linters / lint (push) Waiting to run
Details
Build Pip package / build (push) Waiting to run
Details
Release State / release-state (push) Waiting to run
Details
Parallel Tests / Discover test files (push) Waiting to run
Details
Parallel Tests / ${{ matrix.test.name }} (push) Blocked by required conditions
Details
Parallel Tests / ${{ matrix.plugin.name }} (push) Blocked by required conditions
Details
Run tests / python_tests (ubuntu-22.04, 3.13) (push) Waiting to run
Details
Run tests / docker_tests (push) Waiting to run
Details
docs: regenerate sphinx apidocs to reflect current source tree 
Clean rebuild of docs/apidocs/archivebox/ via autodoc2:
- Removes 19 stale module pages whose source files no longer exist
  (cli_utils, host_utils, schedule_utils — renamed to *_util; actors,
  ideas, debugging, folders, legacy, progress_layout, tests_piping,
  config_tags, personas.runtime/views, orchestrator*, worker, tasks).
- Adds 29 new module pages for code that was added since the previous
  generation but not yet documented.
- Updates 100 existing pages to reflect API surface changes (e.g.
  ENABLED_PLUGINS Field removed, SNAPSHOTS_PER_PAGE clamp removed,
  default bumped to 50, etc.).

156 source modules <-> 156 apidoc files (zero drift). Build clean
under sphinx-build -W --keep-going.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-31 03:40:25 -07:00

5.7 KiB
Raw Blame History

{py:mod}archivebox.config.collection

:allowtitles:

Module Contents

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`_coerce_to_str_dict <archivebox.config.collection._coerce_to_str_dict>`
  - ```{autodoc2-docstring} archivebox.config.collection._coerce_to_str_dict
    :summary:
    ```
* - {py:obj}`_load_file_config_dict <archivebox.config.collection._load_file_config_dict>`
  - ```{autodoc2-docstring} archivebox.config.collection._load_file_config_dict
    :summary:
    ```
* - {py:obj}`_resolve_section_for_key <archivebox.config.collection._resolve_section_for_key>`
  - ```{autodoc2-docstring} archivebox.config.collection._resolve_section_for_key
    :summary:
    ```
* - {py:obj}`_render_config_file_content <archivebox.config.collection._render_config_file_content>`
  - ```{autodoc2-docstring} archivebox.config.collection._render_config_file_content
    :summary:
    ```
* - {py:obj}`_write_file_if_changed <archivebox.config.collection._write_file_if_changed>`
  - ```{autodoc2-docstring} archivebox.config.collection._write_file_if_changed
    :summary:
    ```
* - {py:obj}`mirror_machine_config_to_file <archivebox.config.collection.mirror_machine_config_to_file>`
  - ```{autodoc2-docstring} archivebox.config.collection.mirror_machine_config_to_file
    :summary:
    ```
* - {py:obj}`_coerce_from_str_dict <archivebox.config.collection._coerce_from_str_dict>`
  - ```{autodoc2-docstring} archivebox.config.collection._coerce_from_str_dict
    :summary:
    ```
* - {py:obj}`_mirror_file_to_machine_config <archivebox.config.collection._mirror_file_to_machine_config>`
  - ```{autodoc2-docstring} archivebox.config.collection._mirror_file_to_machine_config
    :summary:
    ```
* - {py:obj}`sync_machine_and_file <archivebox.config.collection.sync_machine_and_file>`
  - ```{autodoc2-docstring} archivebox.config.collection.sync_machine_and_file
    :summary:
    ```
* - {py:obj}`write_config_file <archivebox.config.collection.write_config_file>`
  - ```{autodoc2-docstring} archivebox.config.collection.write_config_file
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`CONFIG_FILE_HEADER <archivebox.config.collection.CONFIG_FILE_HEADER>`
  - ```{autodoc2-docstring} archivebox.config.collection.CONFIG_FILE_HEADER
    :summary:
    ```
* - {py:obj}`_MIRROR_IN_PROGRESS <archivebox.config.collection._MIRROR_IN_PROGRESS>`
  - ```{autodoc2-docstring} archivebox.config.collection._MIRROR_IN_PROGRESS
    :summary:
    ```
* - {py:obj}`_INITIAL_SYNC_DONE <archivebox.config.collection._INITIAL_SYNC_DONE>`
  - ```{autodoc2-docstring} archivebox.config.collection._INITIAL_SYNC_DONE
    :summary:
    ```

API

:canonical: archivebox.config.collection.CONFIG_FILE_HEADER
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.config.collection.CONFIG_FILE_HEADER
```


:canonical: archivebox.config.collection._MIRROR_IN_PROGRESS
:type: bool
:value: >
   False

```{autodoc2-docstring} archivebox.config.collection._MIRROR_IN_PROGRESS
```


:canonical: archivebox.config.collection._INITIAL_SYNC_DONE
:type: bool
:value: >
   False

```{autodoc2-docstring} archivebox.config.collection._INITIAL_SYNC_DONE
```


:canonical: archivebox.config.collection._coerce_to_str_dict

```{autodoc2-docstring} archivebox.config.collection._coerce_to_str_dict
```

:canonical: archivebox.config.collection._load_file_config_dict

```{autodoc2-docstring} archivebox.config.collection._load_file_config_dict
```

:canonical: archivebox.config.collection._resolve_section_for_key

```{autodoc2-docstring} archivebox.config.collection._resolve_section_for_key
```

:canonical: archivebox.config.collection._render_config_file_content

```{autodoc2-docstring} archivebox.config.collection._render_config_file_content
```

:canonical: archivebox.config.collection._write_file_if_changed

```{autodoc2-docstring} archivebox.config.collection._write_file_if_changed
```

:canonical: archivebox.config.collection.mirror_machine_config_to_file

```{autodoc2-docstring} archivebox.config.collection.mirror_machine_config_to_file
```

:canonical: archivebox.config.collection._coerce_from_str_dict

```{autodoc2-docstring} archivebox.config.collection._coerce_from_str_dict
```

:canonical: archivebox.config.collection._mirror_file_to_machine_config

```{autodoc2-docstring} archivebox.config.collection._mirror_file_to_machine_config
```

:canonical: archivebox.config.collection.sync_machine_and_file

```{autodoc2-docstring} archivebox.config.collection.sync_machine_and_file
```

:canonical: archivebox.config.collection.write_config_file

```{autodoc2-docstring} archivebox.config.collection.write_config_file
```