From 8cf4a6f0a63ed3aeed68192a9304fed2bd0ce100 Mon Sep 17 00:00:00 2001 From: Steven Liu <59462357+stevhliu@users.noreply.github.com> Date: Tue, 9 Aug 2022 16:22:55 -0700 Subject: [PATCH] =?UTF-8?q?=20=F0=9F=93=9D=20update=20documentation=20buil?= =?UTF-8?q?d=20section=20(#18548)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/source/en/pr_checks.mdx | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/source/en/pr_checks.mdx b/docs/source/en/pr_checks.mdx index 57e0766c7f6776..8b562b62b29c57 100644 --- a/docs/source/en/pr_checks.mdx +++ b/docs/source/en/pr_checks.mdx @@ -65,13 +65,9 @@ Just in case anything slipped through the cracks, the full test suite is also ru ## Documentation build -The job `ci/circleci: build_doc` runs a build of the documentation just to make sure everything will be okay once your PR is merged. If that steps fails, you can inspect it locally by going into the `docs` folder of the Transformers repo and then typing +The `build_pr_documentation` job builds and generates a preview of the documentation to make sure everything looks okay once your PR is merged. A bot will add a link to preview the documentation in your PR. Any changes you make to the PR are automatically updated in the preview. If the documentation fails to build, click on **Details** next to the failed job to see where things went wrong. Often, the error is as simple as a missing file in the `toctree`. -```bash -make html -``` - -Sphinx is not known for its helpful error messages, so you might have to try a few things to really find the source of the error. +If you're interested in building or previewing the documentation locally, take a look at the [`README.md`](https://github.com/huggingface/transformers/tree/main/docs) in the docs folder. ## Code and documentation style