{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"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.","skillfed_tags":["documentation-generation","markdown-conversion","github-actions"],"use_cases":["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."],"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.\n\nThe 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.","worth_installing":"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."},"id":"hf-doc-builder","links":{"html":"https://skillfed.io/packages/hf-doc-builder","md":"https://skillfed.io/packages/hf-doc-builder.md","pypi":"https://pypi.org/project/hf-doc-builder/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2024-03-11","license_spdx":null,"license_treatment":"permissive","name":"hf-doc-builder","python_support":"unspecified","summary":"Doc building utility"},"popularity":{"monthly_downloads":191439,"position":9882,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.5.0"}