doc-builder
doc-builder copied to clipboard
huggingface
The package used to build the documentation of our Hugging Face repos
Each repository has its own needs in terms of features; Hugging Face Hub, for example, now requires the `versionadded` and `versionchanged` directives. However, these likely take some time to implement....
If designing a docstring of a parameter with an in-line code sample, it will not be rendered correctly, e.g.: ``` Args: argument (`str`): A cool argument ```python import os os.listdir()...
Showing type hints can make the rendered version of the docs quite unreadable, and it'd be nice to be able to disable that. In Sphinx you could do that by...
It seems we're migrating all repos to use this project. I have a few questions which I think would be nice to have answers to while we migrate (ideally I...
AFAIK the documentation specification is currently held in the transformers' documentation guide [here](https://github.com/huggingface/transformers/tree/master/docs#writing-documentation---specification). Having it visible in `doc-builder` with everything that was learned when doing the port of `transformers`, `datasets`,...
Hello, Can we use the doc-builder for another package than transformers ? Is there any hard-coding in doc-builder ? I have some package where I need to build docs. Thanks
Find more details: https://huggingface.slack.com/archives/C02GLJ5S0E9/p1641809520007000 cc: @patrickvonplaten
TLDR: _versions.yml file processing issue Details: https://github.com/huggingface/doc-builder/commit/75db1c7263aeeb4d0e1fc8877fbaa2edbc2eea1f is when we had a version with no subfolder. Then https://github.com/huggingface/doc-builder/commit/48226d041570e7c1b810b83130a94f8217aafb90 is when we had a duplicate version.
Metadata
Owner
Metadata
The package used to build the documentation of our Hugging Face repos