Skip to content

Commit

Permalink
Add redirects readme (#318)
Browse files Browse the repository at this point in the history
  • Loading branch information
mishig25 authored Oct 28, 2022
1 parent 64c5456 commit e4cc563
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,9 +95,11 @@ Note the use of special arguments like `pr_number` and `package` under the `with
doc_folder
├── en
│ ├── _toctree.yml
│ ├── _redirects.yml
│ ...
└── es
├── _toctree.yml
├── _redirects.yml
...
```

Expand All @@ -109,6 +111,15 @@ doc-builder {package_name} {path_to_docs} --build_dir {build_dir} --language {la

To automatically build the documentation for all languages via the GitHub Actions templates, simply provide the `languages` argument to your workflow, with a space-separated list of the languages you wish to build, e.g. `languages: en es`.

#### Redirects

You can optionally provide `_redirects.yml` for "old links". The yml file should look like:

```yml
how_to: getting_started
package_reference/classes: package_reference/main_classes
# old_local: new_local
```

## Writing documentation for Hugging Face libraries

Expand Down

0 comments on commit e4cc563

Please sign in to comment.