hf-doc-builder

What it is and what it does

hf-doc-builder is a documentation generation tool built and maintained by Hugging Face for their own repositories. It takes markdown source files (and optionally Jupyter notebooks) and converts them into MDX and HTML documentation, with built-in support for multilingual docs, code examples, API autodoc, and GitHub Actions workflows.

The package is designed for teams building documentation at scale. It handles notebook-to-markdown conversion, generates searchable HTML output, manages redirects for old links, and provides ready-to-use GitHub Actions templates for automated documentation builds on pull requests and releases. Its runtime dependencies (black, GitPython, tqdm, pyyaml, packaging, nbformat, huggingface-hub) reflect its focus on code formatting, version control integration, progress reporting, and Hugging Face Hub uploads.

Use it for:

• Build and preview documentation locally for a Python library before pushing to production.
• Convert Jupyter notebooks into documentation pages for tutorials and courses.
• Set up automated documentation builds in GitHub Actions that run on every PR and release.
• Maintain documentation in multiple languages with separate table-of-contents files per language.
• Generate HTML documentation with code examples, API references, and cross-references.
• Manage documentation redirects when restructuring or renaming doc pages.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

Builds and previews documentation for Hugging Face repositories, converting markdown and notebooks into MDX and HTML with support for multilingual docs and GitHub Actions integration.

Yes, if you are building documentation for a Hugging Face library or similar Python project and want a turnkey solution with GitHub Actions templates and notebook support. The package is actively maintained, has no security vulnerabilities, and low install friction. Not necessary if you use Sphinx, MkDocs, or other established doc tools for your own projects.

Install

hf-doc-builder on PyPI

pip install hf-doc-builder

uv add hf-doc-builder

poetry add hf-doc-builder

Installing hf-doc-builder

Before you install

Low install friction with a pure Python wheel. Actively maintained with recent commits and no known vulnerabilities. Seven runtime dependencies are all well-established packages (black, GitPython, tqdm, pyyaml, packaging, nbformat, huggingface-hub).

License in practice

Licensed under Apache (permissive), so you can use, modify, and distribute this package freely in both open-source and commercial projects without significant legal restrictions.

Quickstart

pip install hf-doc-builder

doc-builder preview datasets ~/path/to/docs/source/

# or build to HTML
doc-builder build datasets ~/path/to/docs/source --build_dir ~/output --html

Preview command does not work on Windows; HTML output requires Node.js version 14 or higher.

Verify before relying

• Whether the package works with all modern Python versions or has undocumented version constraints.
• Performance characteristics when building large documentation sets with many files or languages.

Package facts

Evidence: hf_doc_builder-0.5.0-py3-none-any.whl

Keywords: doc, documentation, doc-builder, huggingface, hugging, face

Tags

More Documentation packages