From cdb493ec4288cf674aca482aa877542b8bef4055 Mon Sep 17 00:00:00 2001 From: Akihiro Nitta Date: Sat, 16 Jul 2022 02:19:18 +0900 Subject: [PATCH] CI: Update docs-related workflows (#13547) * update Co-authored-by: Jirka --- .circleci/config.yml | 6 +++--- .github/workflows/README.md | 8 +++----- .github/workflows/docs-link.yml | 14 -------------- Makefile | 2 +- docs/source-app/Makefile | 2 +- 5 files changed, 8 insertions(+), 24 deletions(-) delete mode 100644 .github/workflows/docs-link.yml diff --git a/.circleci/config.yml b/.circleci/config.yml index 29fe5fcc1a..91d57cd707 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -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 diff --git a/.github/workflows/README.md b/.github/workflows/README.md index d2084e379c..f377ec4f4d 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -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 diff --git a/.github/workflows/docs-link.yml b/.github/workflows/docs-link.yml deleted file mode 100644 index 2fb83d4b70..0000000000 --- a/.github/workflows/docs-link.yml +++ /dev/null @@ -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! diff --git a/Makefile b/Makefile index eccce47832..aae9d77bb0 100644 --- a/Makefile +++ b/Makefile @@ -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 diff --git a/docs/source-app/Makefile b/docs/source-app/Makefile index 68be4c930e..268e09561b 100644 --- a/docs/source-app/Makefile +++ b/docs/source-app/Makefile @@ -2,7 +2,7 @@ # # You can set these variables from the command line. -SPHINXOPTS = +SPHINXOPTS = -T -W SPHINXBUILD = sphinx-build SOURCEDIR = . BUILDDIR = ../build