{"id":23849,"library":"doc-builder","title":"hf-doc-builder","description":"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.","status":"maintenance","version":"0.5.0","language":"python","source_language":"en","source_url":"https://github.com/huggingface/doc-builder","tags":["documentation","huggingface","hub"],"install":[{"cmd":"pip install doc-builder","lang":"bash","label":"Install from PyPI"}],"dependencies":[],"imports":[{"note":"Package name on PyPI is doc-builder, import uses underscores.","wrong":"from docbuilder import DocBuilder","symbol":"DocBuilder","correct":"from doc_builder import DocBuilder"},{"note":"push_to_hub is in a submodule.","wrong":"from doc_builder import push_to_hub","symbol":"push_to_hub","correct":"from doc_builder.commands.push import push_to_hub"}],"quickstart":{"code":"from doc_builder import DocBuilder\n\nbuilder = DocBuilder(\n    repo_id=\"huggingface/my-docs\",\n    repo_type=\"dataset\",\n    token=os.environ.get(\"HF_TOKEN\", \"\"),\n)\nbuilder.build()","lang":"python","description":"Initialize a DocBuilder with a Hugging Face Hub repo, then build documentation."},"warnings":[{"fix":"Always use `doc_builder` in import statements.","message":"The import path uses underscores: `from doc_builder import ...` even though the PyPI package is `doc-builder`. Using `docbuilder` will fail with ImportError.","severity":"gotcha","affected_versions":"all"},{"fix":"Do not expect deletions to work; manually handle deletions outside the builder.","message":"v0.5.0 reverted a commit that added deletion support in `create_commit` command. If you rely on deletions, update your code.","severity":"breaking","affected_versions":"0.5.0"},{"fix":"Set `HF_TOKEN` environment variable or pass `token=\"...\"` to DocBuilder constructor.","message":"The library requires authentication for private repositories; the token must be passed as a parameter or via `HF_TOKEN` environment variable.","severity":"gotcha","affected_versions":"all"}],"env_vars":null,"last_verified":"2026-05-01T00:00:00.000Z","next_check":"2026-07-30T00:00:00.000Z","problems":[{"fix":"Change import to `from doc_builder import DocBuilder`.","cause":"Incorrect package name in import; the correct module name is `doc_builder`.","error":"ImportError: cannot import name 'DocBuilder' from 'docbuilder'"},{"fix":"Pass `token` argument or set `HF_TOKEN` environment variable.","cause":"DocBuilder requires a token for Hub authentication.","error":"TypeError: __init__() missing required argument: 'token'"}],"ecosystem":"pypi","meta_description":null,"install_score":null,"install_tag":null,"quickstart_score":null,"quickstart_tag":null}