File: //opt/nerfstudio/nerfstudio/scripts/docs/build_docs.py
# Copyright 2022 the Regents of the University of California, Nerfstudio Team and contributors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#!/usr/bin/env python
"""Simple yaml debugger"""
import subprocess
import sys
import tyro
from rich.style import Style
from nerfstudio.utils.rich_utils import CONSOLE
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 nerfstudio/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)