Skip to content

Small typo in docs/README.md #18508

@ankrgyl

Description

@ankrgyl

System Info

Working on main (commit 9129fd0).

The suggested command:

doc-builder build transformers docs/source/ --build_dir ~/tmp/test-build

fails with:

FileNotFoundError: [Errno 2] No such file or directory: 'docs/source/_toctree.yml'

I think is because you have to specify a language (e.g. en) while building the docs, e.g.

doc-builder build transformers docs/source/en/ --build_dir ~/tmp/test-build

I'm happy to contribute a fix.

Who can help?

No response

Information

  • The official example scripts
  • My own modified scripts

Tasks

  • An officially supported task in the examples folder (such as GLUE/SQuAD, ...)
  • My own task or dataset (give details below)

Reproduction

Run the following command:

doc-builder build transformers docs/source/ --build_dir ~/tmp/test-build

Expected behavior

The command should not error, and instead should generate the expected MDX files.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions