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
Brent Yi acd126c1ef
Set dcargs accent color (#465)
* Set dcargs accent color

* Bump required dcargs version

* color -> colour

* Bump dcargs to 0.3.6
2022-09-19 00:28:06 -07:00

53 lines
1.4 KiB
Python
Executable File

#!/usr/bin/env python
"""Simple yaml debugger"""
import subprocess
import sys
import dcargs
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__":
dcargs.extras.set_accent_color("bright_yellow")
dcargs.cli(main)