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
Matthew Tancik 966374474d
Update docs (#244)
* Update docs

* black
2022-08-02 13:51:45 -07:00

49 lines
1.2 KiB
Python

"""Simple yaml debugger"""
import subprocess
import sys
import dcargs
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:
print(f"\033[31mError: `{command}` failed. Exiting...\033[0m")
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.
"""
print_green = lambda x: print(f"\033[32m{x}\033[0m")
print_green("Adding notebook documentation metadata")
run_command("python scripts/docs/add_nb_tags.py")
# Add checks for building documentation
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;'")
print("\n")
print_green("=" * 100)
print_green("Done")
print_green("=" * 100)
if __name__ == "__main__":
dcargs.cli(main)