transformers/docs

Generating the documentation

To generate the documentation, you first have to build it. Building it requires the package sphinx that you can install using:

pip install -U sphinx

You would also need the custom installed theme by Read The Docs. You can install it using the following command:

pip install sphinx_rtd_theme

Once you have setup sphinx, you can build the documentation by running the following command in the /docs folder:

make html

It should build the static app that will be available under /docs/_build/html