From e0f0cd05aa06bdd148a20ed62271d49ff0a6ac9d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ruilong=20Li=28=E6=9D=8E=E7=91=9E=E9=BE=99=29?= Date: Fri, 22 Sep 2023 23:04:02 -0700 Subject: [PATCH] Migrate doc from RTD to gh-pages (#2460) * gh-pages workflow * update doc.yml * update * remove RTD * change action to main * test fail on warning * fail on warnings * get back .readthedocs.yml, a bit cleanup * revert SHA of index.md file --- .github/workflows/doc.yml | 33 +++++++++++++++++++++++++++++++++ docs/Makefile | 2 +- docs/make.bat | 1 + 3 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/doc.yml diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml new file mode 100644 index 000000000..51d07554d --- /dev/null +++ b/.github/workflows/doc.yml @@ -0,0 +1,33 @@ +name: Docs +on: + push: + branches: [main] + pull_request: + branches: [main] + workflow_dispatch: + +permissions: + contents: write +jobs: + docs: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + with: + python-version: '3.9' + - name: Install dependencies + run: | + pip install .[docs] + - name: Sphinx build + # fail on warnings + run: | + sphinx-build docs _build -W --keep-going + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: _build/ + force_orphan: true + # cname: docs.nerf.studio diff --git a/docs/Makefile b/docs/Makefile index d4bb2cbb9..5f8322660 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -3,7 +3,7 @@ # You can set these variables from the command line, and also # from the environment for the first two. -SPHINXOPTS ?= +SPHINXOPTS ?= -W --keep-going # build fail on warning SPHINXBUILD ?= sphinx-build SOURCEDIR = . BUILDDIR = _build diff --git a/docs/make.bat b/docs/make.bat index 32bb24529..008ca8c48 100644 --- a/docs/make.bat +++ b/docs/make.bat @@ -9,6 +9,7 @@ if "%SPHINXBUILD%" == "" ( ) set SOURCEDIR=. set BUILDDIR=_build +set SPHINXOPTS="-W --keep-going" %SPHINXBUILD% >NUL 2>NUL if errorlevel 9009 (