From 2b5458e8529ad465afbbcd744c9139a0bcaea8d4 Mon Sep 17 00:00:00 2001 From: Jirka Borovec Date: Fri, 21 Feb 2020 21:55:03 +0100 Subject: [PATCH] add Sphinx Check (#844) * add sphinx bot * source * typo * Make a change to the docs (#2) * Make a change to the docs * Introduce an error * Install git before building docs * Apply suggestions from code review Co-authored-by: Jirka Borovec * Update docs/source/apex.rst * Update docs/source/apex.rst Co-authored-by: Ammar Askar --- .github/workflows/docs-check.yml | 17 +++++++++++++++++ docs/source/apex.rst | 1 - 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/docs-check.yml diff --git a/.github/workflows/docs-check.yml b/.github/workflows/docs-check.yml new file mode 100644 index 0000000000..a871d651ec --- /dev/null +++ b/.github/workflows/docs-check.yml @@ -0,0 +1,17 @@ +name: "Docs check" +# https://github.com/marketplace/actions/sphinx-build + +on: +- pull_request + +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v1 + - uses: ammaraskar/sphinx-action@master + with: + # git is requried to clone the docs theme + pre-build-command: "apt-get update -y && apt-get install -y git" + docs-folder: "docs/" + repo-token: "${{ secrets.GITHUB_TOKEN }}" diff --git a/docs/source/apex.rst b/docs/source/apex.rst index 3c6b86c7a4..e1c7a1b2c8 100644 --- a/docs/source/apex.rst +++ b/docs/source/apex.rst @@ -57,4 +57,3 @@ TPU 16-bit # turn on 16-bit trainer = Trainer(num_tpu_cores=8, precision=16) -