mirror of
https://github.com/nerfstudio-project/nerfstudio.git
synced 2026-11-12 10:55:57 +08:00
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
This commit is contained in:
1 parent
8812d7a5b0
commit
e0f0cd05aa
3 files changed
+35
-1
No files matched your search
@@ -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
|
||||
+1
-1
@@ -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
|
||||
|
||||
@@ -9,6 +9,7 @@ if "%SPHINXBUILD%" == "" (
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
set SPHINXOPTS="-W --keep-going"
|
||||
|
||||
%SPHINXBUILD% >NUL 2>NUL
|
||||
if errorlevel 9009 (
|
||||
|
||||
Reference in new issue
Block a user