4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 02:24:38 +08:00
nerfstudio/scripts/docs/build_docs.py
Ethan Weber d71c05f256
Google Colab support with viewer (#747)
* allows bridge server to run on a different machine

* added script

* update version

* starting docs

* update docs and scripts

* ngrok support

* use tcp

* moving webrtc outside bridge server. wop

* lazy commit

* lazy commit

* running code. webrtc not working

* lazy commit

* better logic for webrtc connection

* cleanup

* todo comment

* working webrtc

* removed logging

* fixing black

* fix eslint

* fix python version

* fix readme

* misc cleanup

* small docs fix

Co-authored-by: Ethan Weber <ethanweber@Ethans-MacBook-Pro.local>
2022-10-14 15:05:28 -07:00

53 lines
1.4 KiB
Python
Executable File

#!/usr/bin/env python
"""Simple yaml debugger"""
import subprocess
import sys
import tyro
from rich.console import Console
from rich.style import Style
CONSOLE = Console(width=120)
LOCAL_TESTS = ["Run license checks", "Run Black", "Python Pylint", "Test with pytest"]
def run_command(command: str) -> None:
"""Run a command kill actions if it fails
Args:
command: command to run
"""
ret_code = subprocess.call(command, shell=True)
if ret_code != 0:
CONSOLE.print(f"[bold red]Error: `{command}` failed. Exiting...")
sys.exit(1)
def main(clean_cache: bool = False):
"""Run the github actions locally.
Args:
clean_cache: whether to clean the cache before building docs.
"""
CONSOLE.print("[green]Adding notebook documentation metadata")
run_command("python scripts/docs/add_nb_tags.py")
# Add checks for building documentation
CONSOLE.print("[green]Building Documentation")
if clean_cache:
run_command("cd docs/; make clean; make html SPHINXOPTS='-W;'")
else:
run_command("cd docs/; make html SPHINXOPTS='-W;'")
CONSOLE.line()
CONSOLE.rule(characters="=", style=Style(color="green"))
CONSOLE.print("[bold green]Done")
CONSOLE.rule(characters="=", style=Style(color="green"))
if __name__ == "__main__":
tyro.extras.set_accent_color("bright_yellow")
tyro.cli(main)