Skip to content

Commit

Permalink
add Sphinx Check (#844)
Browse files Browse the repository at this point in the history
* 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 <Borda@users.noreply.github.com>

* Update docs/source/apex.rst

* Update docs/source/apex.rst

Co-authored-by: Ammar Askar <ammar_askar@hotmail.com>
  • Loading branch information
Borda and ammaraskar authored Feb 21, 2020
1 parent 5c5a241 commit 2b5458e
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
17 changes: 17 additions & 0 deletions .github/workflows/docs-check.yml
Original file line number Diff line number Diff line change
@@ -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 }}"
1 change: 0 additions & 1 deletion docs/source/apex.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,3 @@ TPU 16-bit
# turn on 16-bit
trainer = Trainer(num_tpu_cores=8, precision=16)

0 comments on commit 2b5458e

Please sign in to comment.