CI: Update docs-related workflows (#13547)

* update

Co-authored-by: Jirka <jirka.borovec@seznam.cz>
This commit is contained in:
Akihiro Nitta 2022-07-16 02:19:18 +09:00 committed by GitHub
parent d42711f22f
commit cdb493ec42
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 8 additions and 24 deletions

View File

@ -158,9 +158,9 @@ jobs:
workflows:
version: 2
build-docs:
jobs:
- build-Docs
#build-docs: # FixMe
# jobs:
# - build-Docs
test-on-tpus:
jobs:
- TPU-tests

View File

@ -23,11 +23,9 @@
## Documentation
| workflow file | action |
| --------------------------------- | -------------------------------------------------------------------------------------------- |
| .github/workflows/docs-checks.yml | Run doctest, build documentation, and upload built docs to make them available as artifacts. |
| .circleci/config.yml (build-docs) | Build docs and host them on output.circleci-artifacts.com for easy access to the built docs. |
| .github/workflows/docs-link.yml | Provide a direct link to built docs on output.circleci-artifacts.com. |
| workflow file | action |
| --------------------------------- | ------------ |
| .github/workflows/docs-checks.yml | Run doctest. |
## Code Quality

View File

@ -1,14 +0,0 @@
name: Docs Link
on: [status]
jobs:
circleci_artifacts_redirector_job:
runs-on: ubuntu-20.04
steps:
- uses: larsoner/circleci-artifacts-redirector-action@master
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
artifact-path: 0/html/index.html
circleci-jobs: build-docs
job-title: Check the rendered docs here!

View File

@ -36,7 +36,7 @@ test: clean
docs: clean
pip install -e . --quiet -r requirements/pytorch/docs.txt
python -m sphinx -b html -W --keep-going docs/source-pytorch docs/build
cd docs && $(MAKE) html
update:
git submodule update --init --recursive --remote

View File

@ -2,7 +2,7 @@
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXOPTS = -T -W
SPHINXBUILD = sphinx-build
SOURCEDIR = .
BUILDDIR = ../build