update cli docs for process-data (#617)

* update cli docs for process-data

* Update recs

* fix toml
This commit is contained in:
Matthew Tancik authored and GitHub committed 2022-10-02 18:09:57 -07:00
1 parent 60bf31844f
commit 37907698f2
9 files changed
+61 -19

No files matched your search

+1
View File
@@ -33,6 +33,7 @@ release = "0.0.0"
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"sphinxarg.ext",
"sphinx.ext.duration",
"sphinx.ext.doctest",
"sphinx.ext.autodoc",
+2 -1
View File
@@ -57,8 +57,9 @@ Contents
:hidden:
:caption: Reference
Contributing<reference/contributing.md>
reference/cli/index
reference/api/index
Contributing<reference/contributing.md>
+8
View File
@@ -0,0 +1,8 @@
.. _cli:
CLI
============
.. toctree::
ns_process_data
+14
View File
@@ -0,0 +1,14 @@
# ns-process-data
:::{admonition} Note
:class: warning
Make sure to have [COLMAP](https://colmap.github.io) and [FFmpeg](https://ffmpeg.org/download.html) installed.
:::
```{eval-rst}
.. argparse::
:module: scripts.process_data
:func: get_parser_fn
:prog: ns-process-data
:nodefault:
```
+2 -2
View File
@@ -9,10 +9,10 @@ To assist running on custom data we have a script that will process a video or f
To process your data run:
```bash
python scripts/process_data.py --data FOLDER_OR_VIDEO --output-dir PROCESSED_DATA_DIR
ns-process-data --data FOLDER_OR_VIDEO --output-dir PROCESSED_DATA_DIR
```
If your data was captured with a fisheye camera add `--camera-type fisheye`.
A full set of arguments can be found {doc}`here</reference/cli/ns_process_data>`.
:::{admonition} Tip
:class: info
-2
View File
@@ -1,8 +1,6 @@
Data Setup
----------
# TODO: high level summary
.. toctree::
:maxdepth: 1