hf-doc-builder
Doc building utility
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Preview command does not work on Windows; HTML output requires Node.js version 14 or higher.
- Low install friction with a pure Python wheel.
- Actively maintained with recent commits and no known vulnerabilities.
License · maintenance · safety
Apache (permissive) — 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.
last release 2024-03-11 (886 days) · last repo commit 2026-08-07 · 140 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 191,439 downloads/mo, #9,882 on PyPI
Alternatives
Verify before relying
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- 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.
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 on it.
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
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).
Preview command does not work on Windows; HTML output requires Node.js version 14 or higher.
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 --htmlVerify 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
| License | Apache permissive |
| Python support | Not specified |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 7 packagesblackGitPythontqdmpyyamlpackagingnbformathuggingface-hub |
| Maintenance | Actively maintained 886 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 191,439 / month, #9,882 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
Evidence: hf_doc_builder-0.5.0-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “documentation builder”
- hf-doc-builderBuilds and previews documentation for Hugging Face repositories,…
- sphinx-simplepdfSphinx-SimplePDF is a Sphinx extension that converts Sphinx…
- sphinx-markdown-builderA Sphinx extension that generates Markdown output from…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also hf · huggingface-hub · mkdocs-jupyter · hf-xet · langchain-huggingface · spaces · pyspark-huggingface · myst-nb · mdxpy · datasets