4
0
mirror of https://github.com/nerfstudio-project/nerfstudio.git synced 2026-11-11 10:34:29 +08:00

Update cli docs (#663)

This commit is contained in:
Matthew Tancik 2022-10-04 17:43:03 -07:00 committed by GitHub
parent 17802a12a0
commit 0b3909918a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 33 additions and 1 deletions

View File

@ -4,5 +4,8 @@ CLI
============
.. toctree::
:maxdepth: 1
ns_process_data
ns_process_data
ns_render
ns_eval

View File

@ -0,0 +1,9 @@
# ns-eval
```{eval-rst}
.. argparse::
:module: scripts.eval
:func: get_parser_fn
:prog: ns-process-data
:nodefault:
```

View File

@ -0,0 +1,14 @@
# ns-render
:::{admonition} Note
:class: warning
Make sure to have [FFmpeg](https://ffmpeg.org/download.html) installed.
:::
```{eval-rst}
.. argparse::
:module: scripts.render
:func: get_parser_fn
:prog: ns-process-data
:nodefault:
```

View File

@ -54,3 +54,6 @@ def entrypoint():
if __name__ == "__main__":
entrypoint()
# For sphinx docs
get_parser_fn = lambda: dcargs.extras.get_parser(ComputePSNR) # noqa

View File

@ -146,3 +146,6 @@ def entrypoint():
if __name__ == "__main__":
entrypoint()
# For sphinx docs
get_parser_fn = lambda: dcargs.extras.get_parser(RenderTrajectory) # noqa