doc-builder

library0.5.0pypypiunverified

Doc building utility by Hugging Face, version 0.5.0, used to generate and push documentation from source code and markdown files. Release cadence is irregular, with last release v0.5.0 in 2022.

devops

pip install doc-builder

homepage ↗

INSTALL

IMPORT

SIG · DOC-BUILDER

doc-builder

devopspythonv0.5.0

Install

—

Import

—

Disk

—

Pass rate

0/ 10

Env Coverage0 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v? · pip install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

build_error

glibc

py 3.10–3.95 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

DocBuilder

✓ from doc_builder import DocBuilder

✗ from docbuilder import DocBuilder

Package name on PyPI is doc-builder, import uses underscores.

push_to_hub

✓ from doc_builder.commands.push import push_to_hub

✗ from doc_builder import push_to_hub

push_to_hub is in a submodule.

Initialize a DocBuilder with a Hugging Face Hub repo, then build documentation.

from doc_builder import DocBuilder builder = DocBuilder( repo_id="huggingface/my-docs", repo_type="dataset", token=os.environ.get("HF_TOKEN", ""), ) builder.build()

doc-builder --version

Debug

Known issues

gotchaThe import path uses underscores: `from doc_builder import ...` even though the PyPI package is `doc-builder`. Using `docbuilder` will fail with ImportError.

fix

Always use `doc_builder` in import statements.

affects: all

breakingv0.5.0 reverted a commit that added deletion support in `create_commit` command. If you rely on deletions, update your code.

fix

Do not expect deletions to work; manually handle deletions outside the builder.

affects: 0.5.0

gotchaThe library requires authentication for private repositories; the token must be passed as a parameter or via `HF_TOKEN` environment variable.

fix

Set `HF_TOKEN` environment variable or pass `token="..."` to DocBuilder constructor.

affects: all

Upgrade

Version history

0.5.0latest on PyPI

Audit

Dependencies

No dependency data recorded yet.

Agent activity

7 hits · last 30 days

node

Amazon

Resources

homepagehttps://huggingface.co/docs/hub ↗