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
dev
ArchiveBox/docs/apidocs/archivebox/archivebox.misc.logging.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

4.6 KiB
Raw Permalink Blame History

{py:mod}archivebox.misc.logging

:allowtitles:

Module Contents

Classes

:class: autosummary longtable
:align: left

* - {py:obj}`AttrDict <archivebox.misc.logging.AttrDict>`
  -
* - {py:obj}`RainbowHighlighter <archivebox.misc.logging.RainbowHighlighter>`
  -

Functions

:class: autosummary longtable
:align: left

* - {py:obj}`stdout <archivebox.misc.logging.stdout>`
  - ```{autodoc2-docstring} archivebox.misc.logging.stdout
    :summary:
    ```
* - {py:obj}`stderr <archivebox.misc.logging.stderr>`
  - ```{autodoc2-docstring} archivebox.misc.logging.stderr
    :summary:
    ```
* - {py:obj}`hint <archivebox.misc.logging.hint>`
  - ```{autodoc2-docstring} archivebox.misc.logging.hint
    :summary:
    ```

Data

:class: autosummary longtable
:align: left

* - {py:obj}`CONSOLE <archivebox.misc.logging.CONSOLE>`
  - ```{autodoc2-docstring} archivebox.misc.logging.CONSOLE
    :summary:
    ```
* - {py:obj}`STDERR <archivebox.misc.logging.STDERR>`
  - ```{autodoc2-docstring} archivebox.misc.logging.STDERR
    :summary:
    ```
* - {py:obj}`IS_TTY <archivebox.misc.logging.IS_TTY>`
  - ```{autodoc2-docstring} archivebox.misc.logging.IS_TTY
    :summary:
    ```
* - {py:obj}`rainbow <archivebox.misc.logging.rainbow>`
  - ```{autodoc2-docstring} archivebox.misc.logging.rainbow
    :summary:
    ```
* - {py:obj}`DEFAULT_CLI_COLORS <archivebox.misc.logging.DEFAULT_CLI_COLORS>`
  - ```{autodoc2-docstring} archivebox.misc.logging.DEFAULT_CLI_COLORS
    :summary:
    ```
* - {py:obj}`ANSI <archivebox.misc.logging.ANSI>`
  - ```{autodoc2-docstring} archivebox.misc.logging.ANSI
    :summary:
    ```
* - {py:obj}`COLOR_DICT <archivebox.misc.logging.COLOR_DICT>`
  - ```{autodoc2-docstring} archivebox.misc.logging.COLOR_DICT
    :summary:
    ```

API

:canonical: archivebox.misc.logging.CONSOLE
:value: >
   'Console(...)'

```{autodoc2-docstring} archivebox.misc.logging.CONSOLE
```


:canonical: archivebox.misc.logging.STDERR
:value: >
   'Console(...)'

```{autodoc2-docstring} archivebox.misc.logging.STDERR
```


:canonical: archivebox.misc.logging.IS_TTY
:value: >
   'isatty(...)'

```{autodoc2-docstring} archivebox.misc.logging.IS_TTY
```


:canonical: archivebox.misc.logging.AttrDict

Bases: {py:obj}`dict`

````{py:method} _wrap(value)
:canonical: archivebox.misc.logging.AttrDict._wrap
:classmethod:

```{autodoc2-docstring} archivebox.misc.logging.AttrDict._wrap
```

````

````{py:method} __setitem__(key, value)
:canonical: archivebox.misc.logging.AttrDict.__setitem__

````

````{py:method} update(*args, **kwargs)
:canonical: archivebox.misc.logging.AttrDict.update

````

````{py:method} __getattr__(key)
:canonical: archivebox.misc.logging.AttrDict.__getattr__

```{autodoc2-docstring} archivebox.misc.logging.AttrDict.__getattr__
```

````


:canonical: archivebox.misc.logging.RainbowHighlighter

Bases: {py:obj}`rich.highlighter.Highlighter`

````{py:method} highlight(text)
:canonical: archivebox.misc.logging.RainbowHighlighter.highlight

````


:canonical: archivebox.misc.logging.rainbow
:value: >
   'RainbowHighlighter(...)'

```{autodoc2-docstring} archivebox.misc.logging.rainbow
```


:canonical: archivebox.misc.logging.DEFAULT_CLI_COLORS
:value: >
   'AttrDict(...)'

```{autodoc2-docstring} archivebox.misc.logging.DEFAULT_CLI_COLORS
```


:canonical: archivebox.misc.logging.ANSI
:value: >
   'AttrDict(...)'

```{autodoc2-docstring} archivebox.misc.logging.ANSI
```


:canonical: archivebox.misc.logging.COLOR_DICT
:value: >
   'defaultdict(...)'

```{autodoc2-docstring} archivebox.misc.logging.COLOR_DICT
```


:canonical: archivebox.misc.logging.stdout

```{autodoc2-docstring} archivebox.misc.logging.stdout
```

:canonical: archivebox.misc.logging.stderr

```{autodoc2-docstring} archivebox.misc.logging.stderr
```

:canonical: archivebox.misc.logging.hint

```{autodoc2-docstring} archivebox.misc.logging.hint
```