diff --git a/docs/reference/cli/index.rst b/docs/reference/cli/index.rst index 321fa207d..f99746fd6 100644 --- a/docs/reference/cli/index.rst +++ b/docs/reference/cli/index.rst @@ -4,5 +4,8 @@ CLI ============ .. toctree:: + :maxdepth: 1 - ns_process_data \ No newline at end of file + ns_process_data + ns_render + ns_eval \ No newline at end of file diff --git a/docs/reference/cli/ns_eval.md b/docs/reference/cli/ns_eval.md new file mode 100644 index 000000000..bc552dcf0 --- /dev/null +++ b/docs/reference/cli/ns_eval.md @@ -0,0 +1,9 @@ +# ns-eval + +```{eval-rst} +.. argparse:: + :module: scripts.eval + :func: get_parser_fn + :prog: ns-process-data + :nodefault: +``` diff --git a/docs/reference/cli/ns_render.md b/docs/reference/cli/ns_render.md new file mode 100644 index 000000000..33ca5fc4a --- /dev/null +++ b/docs/reference/cli/ns_render.md @@ -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: +``` diff --git a/scripts/eval.py b/scripts/eval.py index 33b0e7540..b9b0cd73d 100755 --- a/scripts/eval.py +++ b/scripts/eval.py @@ -54,3 +54,6 @@ def entrypoint(): if __name__ == "__main__": entrypoint() + +# For sphinx docs +get_parser_fn = lambda: dcargs.extras.get_parser(ComputePSNR) # noqa diff --git a/scripts/render.py b/scripts/render.py index 8da733855..5e6ea9d72 100644 --- a/scripts/render.py +++ b/scripts/render.py @@ -146,3 +146,6 @@ def entrypoint(): if __name__ == "__main__": entrypoint() + +# For sphinx docs +get_parser_fn = lambda: dcargs.extras.get_parser(RenderTrajectory) # noqa