From 4c85cba3ab2c2dc0ac9b6aa556175910b9d7547c Mon Sep 17 00:00:00 2001 From: Matt Tancik Date: Mon, 13 Jun 2022 16:35:25 -0700 Subject: [PATCH] Add notebooks to documentation --- docs/conf.py | 1 + docs/index.rst | 6 ++++++ docs/notebooks/index.rst | 17 +++++++++++++++++ .../notebooks}/visualize_cameras.ipynb | 0 .../notebooks}/visualize_encoders.ipynb | 0 docs/requirements.txt | 1 + 6 files changed, 25 insertions(+) create mode 100644 docs/notebooks/index.rst rename {notebooks => docs/notebooks}/visualize_cameras.ipynb (100%) rename {notebooks => docs/notebooks}/visualize_encoders.ipynb (100%) diff --git a/docs/conf.py b/docs/conf.py index 4cbab73b2..124a2b44d 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,6 +41,7 @@ extensions = [ "myst_parser", "sphinx.ext.napoleon", "sphinx_copybutton", + "nbsphinx", ] # List of patterns, relative to source directory, that match files and diff --git a/docs/index.rst b/docs/index.rst index ce53927a2..046552332 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -38,7 +38,13 @@ Contents .. toctree:: :hidden: :caption: Reference + + notebooks/index +.. toctree:: + :hidden: + :caption: API + reference/index diff --git a/docs/notebooks/index.rst b/docs/notebooks/index.rst new file mode 100644 index 000000000..ea61d8da0 --- /dev/null +++ b/docs/notebooks/index.rst @@ -0,0 +1,17 @@ +.. _notebooks: + +Cameras +----------- + +.. toctree:: + :maxdepth: 0 + + visualize_cameras.ipynb + +Encoders +----------- + +.. toctree:: + :maxdepth: 0 + + visualize_encoders.ipynb \ No newline at end of file diff --git a/notebooks/visualize_cameras.ipynb b/docs/notebooks/visualize_cameras.ipynb similarity index 100% rename from notebooks/visualize_cameras.ipynb rename to docs/notebooks/visualize_cameras.ipynb diff --git a/notebooks/visualize_encoders.ipynb b/docs/notebooks/visualize_encoders.ipynb similarity index 100% rename from notebooks/visualize_encoders.ipynb rename to docs/notebooks/visualize_encoders.ipynb diff --git a/docs/requirements.txt b/docs/requirements.txt index 94d708e23..2e1fe42a7 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,6 +1,7 @@ furo==2022.4.7 readthedocs-sphinx-search==0.1.2 myst-parser==0.17.2 +nbsphinx==0.8.9 sphinx==4.5.0 sphinxemoji==0.2.0 sphinx-copybutton==0.5.0 \ No newline at end of file