d2010d5165
* Move to maturing mimicking move for `safetensors`. * Tmp. * Fix sdist. * Wat? * Clippy 1.72 * Remove if. * Conda sed. * Fix doc check workflow. * Moving to maturin AND removing http + openssl mess (smoothing transition moving to `huggingface_hub`) * Fix dep * Black. * New node bindings. * Fix docs + node cache ? * Yarn. * Working dir. * Extension module. * Put back interpreter. * Remove cache. * New attempt * Multi python. * Remove FromPretrained. * Remove traces of `fromPretrained`. * Drop 3.12 for windows? * Typo. * Put back the default feature for ignoring links during simple test. * Fix ? * x86_64 -> x64. * Remove warning for windows bindings. * Excluse aarch. * Include/exclude. * Put back workflows in correct states.
Requirements
In order to generate the documentation, it is necessary to have a Python environment with the following:
pip install sphinx sphinx_rtd_theme setuptools_rust
It is also necessary to have the tokenizers library in this same environment, for Sphinx to
generate all the API Reference and links properly. If you want to visualize the documentation with
some modifications made to the Python bindings, make sure you build it from source.
Building the documentation
Once everything is setup, you can build the documentation automatically for all the languages
using the following command in the /docs folder:
make html_all
If you want to build only for a specific language, you can use:
make html O="-t python"
(Replacing python by the target language among rust, node, and python)
NOTE
If you are making any structural change to the documentation, it is recommended to clean the build directory before rebuilding:
make clean && make html_all