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.misc.toml_util.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

3.4 KiB
Raw Blame History

{py:mod}archivebox.misc.toml_util

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`JSONSchemaWithLambdas <archivebox.misc.toml_util.JSONSchemaWithLambdas>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.JSONSchemaWithLambdas
    :summary:
    ```
* - {py:obj}`CustomTOMLEncoder <archivebox.misc.toml_util.CustomTOMLEncoder>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.CustomTOMLEncoder
    :summary:
    ```

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`load_ini_value <archivebox.misc.toml_util.load_ini_value>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.load_ini_value
    :summary:
    ```
* - {py:obj}`convert <archivebox.misc.toml_util.convert>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.convert
    :summary:
    ```
* - {py:obj}`better_toml_dump_str <archivebox.misc.toml_util.better_toml_dump_str>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.better_toml_dump_str
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`JSONValue <archivebox.misc.toml_util.JSONValue>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.JSONValue
    :summary:
    ```
* - {py:obj}`TOML_HEADER <archivebox.misc.toml_util.TOML_HEADER>`
  - ```{autodoc2-docstring} archivebox.misc.toml_util.TOML_HEADER
    :summary:
    ```

API

:canonical: archivebox.misc.toml_util.JSONValue
:value: >
   None

```{autodoc2-docstring} archivebox.misc.toml_util.JSONValue
```


:canonical: archivebox.misc.toml_util.TOML_HEADER
:value: <Multiline-String>

```{autodoc2-docstring} archivebox.misc.toml_util.TOML_HEADER
```


:canonical: archivebox.misc.toml_util.load_ini_value

```{autodoc2-docstring} archivebox.misc.toml_util.load_ini_value
```

:canonical: archivebox.misc.toml_util.convert

```{autodoc2-docstring} archivebox.misc.toml_util.convert
```

:canonical: archivebox.misc.toml_util.JSONSchemaWithLambdas

Bases: {py:obj}`pydantic.json_schema.GenerateJsonSchema`

```{autodoc2-docstring} archivebox.misc.toml_util.JSONSchemaWithLambdas
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.misc.toml_util.JSONSchemaWithLambdas.__init__
```

````{py:method} encode_default(dft: typing.Any) -> typing.Any
:canonical: archivebox.misc.toml_util.JSONSchemaWithLambdas.encode_default

````


:canonical: archivebox.misc.toml_util.better_toml_dump_str

```{autodoc2-docstring} archivebox.misc.toml_util.better_toml_dump_str
```

:canonical: archivebox.misc.toml_util.CustomTOMLEncoder

Bases: {py:obj}`toml.encoder.TomlEncoder`

```{autodoc2-docstring} archivebox.misc.toml_util.CustomTOMLEncoder
```

```{rubric} Initialization
```

```{autodoc2-docstring} archivebox.misc.toml_util.CustomTOMLEncoder.__init__
```