From 9a0b0c2e74ea47176805d84385c67dfdf00936f3 Mon Sep 17 00:00:00 2001 From: Jeremy Reizenstein Date: Tue, 15 Nov 2022 14:10:22 -0800 Subject: [PATCH] renderer and vis readthedocs #1363 Summary: Autogenerate docs for the renderer too. This will be helpful but make a slightly ugly TOC Reviewed By: kjchalup Differential Revision: D40977315 fbshipit-source-id: 10831de3ced68080cb5671c5dc31d4da8500f761 --- ...implicitron_stubs.py => generate_stubs.py} | 108 ++++++++++-------- docs/modules/index.rst | 2 +- docs/modules/renderer/blending.rst | 6 +- docs/modules/renderer/camera_conversions.rst | 9 ++ docs/modules/renderer/camera_utils.rst | 9 ++ docs/modules/renderer/cameras.rst | 6 +- docs/modules/renderer/compositing.rst | 9 ++ docs/modules/renderer/fisheyecameras.rst | 9 ++ .../renderer/implicit/harmonic_embedding.rst | 9 ++ docs/modules/renderer/implicit/index.rst | 11 ++ .../modules/renderer/implicit/raymarching.rst | 9 ++ .../modules/renderer/implicit/raysampling.rst | 9 ++ docs/modules/renderer/implicit/renderer.rst | 9 ++ docs/modules/renderer/implicit/sample_pdf.rst | 9 ++ docs/modules/renderer/implicit/utils.rst | 9 ++ docs/modules/renderer/index.rst | 22 ++-- docs/modules/renderer/lighting.rst | 7 +- docs/modules/renderer/materials.rst | 6 +- docs/modules/renderer/mesh/clip.rst | 9 ++ docs/modules/renderer/mesh/index.rst | 13 +++ .../renderer/mesh/rasterize_meshes.rst | 9 ++ docs/modules/renderer/mesh/rasterizer.rst | 9 ++ docs/modules/renderer/mesh/renderer.rst | 9 ++ docs/modules/renderer/{ => mesh}/shader.rst | 6 +- docs/modules/renderer/{ => mesh}/shading.rst | 6 +- docs/modules/renderer/mesh/textures.rst | 9 ++ docs/modules/renderer/mesh/utils.rst | 9 ++ docs/modules/renderer/opengl/index.rst | 7 ++ docs/modules/renderer/opengl/opengl_utils.rst | 9 ++ .../renderer/opengl/rasterizer_opengl.rst | 9 ++ docs/modules/renderer/points/compositor.rst | 9 ++ docs/modules/renderer/points/index.rst | 10 ++ docs/modules/renderer/points/pulsar/index.rst | 7 ++ .../renderer/points/pulsar/renderer.rst | 9 ++ .../renderer/points/pulsar/unified.rst | 9 ++ .../renderer/points/rasterize_points.rst | 9 ++ docs/modules/renderer/points/rasterizer.rst | 9 ++ docs/modules/renderer/points/renderer.rst | 9 ++ docs/modules/renderer/rasterizer.rst | 10 -- docs/modules/renderer/splatter_blend.rst | 9 ++ docs/modules/renderer/texturing.rst | 7 -- docs/modules/renderer/utils.rst | 7 +- docs/modules/vis.rst | 6 - docs/modules/vis/index.rst | 7 ++ docs/modules/vis/plotly_vis.rst | 9 ++ docs/modules/vis/texture_vis.rst | 9 ++ 46 files changed, 403 insertions(+), 94 deletions(-) rename docs/{generate_implicitron_stubs.py => generate_stubs.py} (58%) mode change 100755 => 100644 create mode 100644 docs/modules/renderer/camera_conversions.rst create mode 100644 docs/modules/renderer/camera_utils.rst create mode 100644 docs/modules/renderer/compositing.rst create mode 100644 docs/modules/renderer/fisheyecameras.rst create mode 100644 docs/modules/renderer/implicit/harmonic_embedding.rst create mode 100644 docs/modules/renderer/implicit/index.rst create mode 100644 docs/modules/renderer/implicit/raymarching.rst create mode 100644 docs/modules/renderer/implicit/raysampling.rst create mode 100644 docs/modules/renderer/implicit/renderer.rst create mode 100644 docs/modules/renderer/implicit/sample_pdf.rst create mode 100644 docs/modules/renderer/implicit/utils.rst create mode 100644 docs/modules/renderer/mesh/clip.rst create mode 100644 docs/modules/renderer/mesh/index.rst create mode 100644 docs/modules/renderer/mesh/rasterize_meshes.rst create mode 100644 docs/modules/renderer/mesh/rasterizer.rst create mode 100644 docs/modules/renderer/mesh/renderer.rst rename docs/modules/renderer/{ => mesh}/shader.rst (50%) rename docs/modules/renderer/{ => mesh}/shading.rst (50%) create mode 100644 docs/modules/renderer/mesh/textures.rst create mode 100644 docs/modules/renderer/mesh/utils.rst create mode 100644 docs/modules/renderer/opengl/index.rst create mode 100644 docs/modules/renderer/opengl/opengl_utils.rst create mode 100644 docs/modules/renderer/opengl/rasterizer_opengl.rst create mode 100644 docs/modules/renderer/points/compositor.rst create mode 100644 docs/modules/renderer/points/index.rst create mode 100644 docs/modules/renderer/points/pulsar/index.rst create mode 100644 docs/modules/renderer/points/pulsar/renderer.rst create mode 100644 docs/modules/renderer/points/pulsar/unified.rst create mode 100644 docs/modules/renderer/points/rasterize_points.rst create mode 100644 docs/modules/renderer/points/rasterizer.rst create mode 100644 docs/modules/renderer/points/renderer.rst delete mode 100644 docs/modules/renderer/rasterizer.rst create mode 100644 docs/modules/renderer/splatter_blend.rst delete mode 100644 docs/modules/renderer/texturing.rst delete mode 100644 docs/modules/vis.rst create mode 100644 docs/modules/vis/index.rst create mode 100644 docs/modules/vis/plotly_vis.rst create mode 100644 docs/modules/vis/texture_vis.rst diff --git a/docs/generate_implicitron_stubs.py b/docs/generate_stubs.py old mode 100755 new mode 100644 similarity index 58% rename from docs/generate_implicitron_stubs.py rename to docs/generate_stubs.py index 3404136e..e31519f9 --- a/docs/generate_implicitron_stubs.py +++ b/docs/generate_stubs.py @@ -12,7 +12,6 @@ This script makes the stubs for implicitron in docs/modules. from pathlib import Path ROOT_DIR = Path(__file__).resolve().parent.parent -DEST_DIR = Path(__file__).resolve().parent / "modules/implicitron" def paths_to_modules(paths): @@ -95,54 +94,69 @@ def make_directory_index(title: str, directory_path: Path): print(f" {rst.stem}", file=f) -iterate_directory(ROOT_DIR / "pytorch3d/implicitron/models", DEST_DIR / "models") +def do_implicitron(): + DEST_DIR = Path(__file__).resolve().parent / "modules/implicitron" -unwanted_tools = ["configurable", "depth_cleanup", "utils"] -tools_sources = sorted(ROOT_DIR.glob("pytorch3d/implicitron/tools/*.py")) -tools_modules = [ - str(i.relative_to(ROOT_DIR))[:-3].replace("/", ".") - for i in tools_sources - if i.stem not in unwanted_tools -] -create_one_file( - "pytorch3d.implicitron.tools", - "Tools for implicitron", - tools_modules, - DEST_DIR / "tools.rst", -) + iterate_directory(ROOT_DIR / "pytorch3d/implicitron/models", DEST_DIR / "models") -dataset_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/dataset/*.py")) -basic_dataset = [ - "dataset_base", - "dataset_map_provider", - "data_loader_map_provider", - "data_source", - "scene_batch_sampler", -] -basic_dataset_modules = [f"pytorch3d.implicitron.dataset.{i}" for i in basic_dataset] -create_one_file( - "pytorch3d.implicitron.dataset in general", - "Basics of data for implicitron", - basic_dataset_modules, - DEST_DIR / "data_basics.rst", -) + unwanted_tools = ["configurable", "depth_cleanup", "utils"] + tools_sources = sorted(ROOT_DIR.glob("pytorch3d/implicitron/tools/*.py")) + tools_modules = [ + str(i.relative_to(ROOT_DIR))[:-3].replace("/", ".") + for i in tools_sources + if i.stem not in unwanted_tools + ] + create_one_file( + "pytorch3d.implicitron.tools", + "Tools for implicitron", + tools_modules, + DEST_DIR / "tools.rst", + ) -specific_dataset_files = [ - i for i in dataset_files if i.stem.find("_dataset_map_provider") != -1 -] -create_one_file( - "pytorch3d.implicitron.dataset specific datasets", - "specific datasets", - paths_to_modules(specific_dataset_files), - DEST_DIR / "datasets.rst", -) + dataset_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/dataset/*.py")) + basic_dataset = [ + "dataset_base", + "dataset_map_provider", + "data_loader_map_provider", + "data_source", + "scene_batch_sampler", + ] + basic_dataset_modules = [ + f"pytorch3d.implicitron.dataset.{i}" for i in basic_dataset + ] + create_one_file( + "pytorch3d.implicitron.dataset in general", + "Basics of data for implicitron", + basic_dataset_modules, + DEST_DIR / "data_basics.rst", + ) -evaluation_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/evaluation/*.py")) -create_one_file( - "pytorch3d.implicitron.evaluation", - "evaluation", - paths_to_modules(evaluation_files), - DEST_DIR / "evaluation.rst", -) + specific_dataset_files = [ + i for i in dataset_files if i.stem.find("_dataset_map_provider") != -1 + ] + create_one_file( + "pytorch3d.implicitron.dataset specific datasets", + "specific datasets", + paths_to_modules(specific_dataset_files), + DEST_DIR / "datasets.rst", + ) -make_directory_index("pytorch3d.implicitron", DEST_DIR) + evaluation_files = sorted(ROOT_DIR.glob("pytorch3d/implicitron/evaluation/*.py")) + create_one_file( + "pytorch3d.implicitron.evaluation", + "evaluation", + paths_to_modules(evaluation_files), + DEST_DIR / "evaluation.rst", + ) + + make_directory_index("pytorch3d.implicitron", DEST_DIR) + + +def iterate_toplevel_module(name: str) -> None: + dest_dir = Path(__file__).resolve().parent / "modules" / name + iterate_directory(ROOT_DIR / "pytorch3d" / name, dest_dir) + + +do_implicitron() +iterate_toplevel_module("renderer") +iterate_toplevel_module("vis") diff --git a/docs/modules/index.rst b/docs/modules/index.rst index 18017a16..54550d8a 100644 --- a/docs/modules/index.rst +++ b/docs/modules/index.rst @@ -12,5 +12,5 @@ API Documentation utils datasets common - vis + vis/index implicitron/index diff --git a/docs/modules/renderer/blending.rst b/docs/modules/renderer/blending.rst index 0233a0c3..6f6a1910 100644 --- a/docs/modules/renderer/blending.rst +++ b/docs/modules/renderer/blending.rst @@ -1,7 +1,9 @@ -blending +pytorch3d.renderer.blending =========================== +blending + .. automodule:: pytorch3d.renderer.blending :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/modules/renderer/camera_conversions.rst b/docs/modules/renderer/camera_conversions.rst new file mode 100644 index 00000000..c6144e0c --- /dev/null +++ b/docs/modules/renderer/camera_conversions.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.camera_conversions +===================================== + +camera_conversions + +.. automodule:: pytorch3d.renderer.camera_conversions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/camera_utils.rst b/docs/modules/renderer/camera_utils.rst new file mode 100644 index 00000000..2cd3c5ac --- /dev/null +++ b/docs/modules/renderer/camera_utils.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.camera_utils +=============================== + +camera_utils + +.. automodule:: pytorch3d.renderer.camera_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/cameras.rst b/docs/modules/renderer/cameras.rst index 33e634dc..201ca044 100644 --- a/docs/modules/renderer/cameras.rst +++ b/docs/modules/renderer/cameras.rst @@ -1,7 +1,9 @@ +pytorch3d.renderer.cameras +========================== + cameras -=========================== .. automodule:: pytorch3d.renderer.cameras :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/modules/renderer/compositing.rst b/docs/modules/renderer/compositing.rst new file mode 100644 index 00000000..7b2c5ea9 --- /dev/null +++ b/docs/modules/renderer/compositing.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.compositing +============================== + +compositing + +.. automodule:: pytorch3d.renderer.compositing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/fisheyecameras.rst b/docs/modules/renderer/fisheyecameras.rst new file mode 100644 index 00000000..039b1646 --- /dev/null +++ b/docs/modules/renderer/fisheyecameras.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.fisheyecameras +================================= + +fisheyecameras + +.. automodule:: pytorch3d.renderer.fisheyecameras + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/implicit/harmonic_embedding.rst b/docs/modules/renderer/implicit/harmonic_embedding.rst new file mode 100644 index 00000000..46038131 --- /dev/null +++ b/docs/modules/renderer/implicit/harmonic_embedding.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.implicit.harmonic_embedding +============================================== + +harmonic_embedding + +.. automodule:: pytorch3d.renderer.implicit.harmonic_embedding + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/implicit/index.rst b/docs/modules/renderer/implicit/index.rst new file mode 100644 index 00000000..e62048b6 --- /dev/null +++ b/docs/modules/renderer/implicit/index.rst @@ -0,0 +1,11 @@ +pytorch3d.renderer.implicit +=========================== + +.. toctree:: + + harmonic_embedding + raymarching + raysampling + renderer + sample_pdf + utils diff --git a/docs/modules/renderer/implicit/raymarching.rst b/docs/modules/renderer/implicit/raymarching.rst new file mode 100644 index 00000000..c44c607d --- /dev/null +++ b/docs/modules/renderer/implicit/raymarching.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.implicit.raymarching +======================================= + +raymarching + +.. automodule:: pytorch3d.renderer.implicit.raymarching + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/implicit/raysampling.rst b/docs/modules/renderer/implicit/raysampling.rst new file mode 100644 index 00000000..23f9e409 --- /dev/null +++ b/docs/modules/renderer/implicit/raysampling.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.implicit.raysampling +======================================= + +raysampling + +.. automodule:: pytorch3d.renderer.implicit.raysampling + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/implicit/renderer.rst b/docs/modules/renderer/implicit/renderer.rst new file mode 100644 index 00000000..2e27e86f --- /dev/null +++ b/docs/modules/renderer/implicit/renderer.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.implicit.renderer +==================================== + +renderer + +.. automodule:: pytorch3d.renderer.implicit.renderer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/implicit/sample_pdf.rst b/docs/modules/renderer/implicit/sample_pdf.rst new file mode 100644 index 00000000..5c35f789 --- /dev/null +++ b/docs/modules/renderer/implicit/sample_pdf.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.implicit.sample_pdf +====================================== + +sample_pdf + +.. automodule:: pytorch3d.renderer.implicit.sample_pdf + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/implicit/utils.rst b/docs/modules/renderer/implicit/utils.rst new file mode 100644 index 00000000..1d7f976f --- /dev/null +++ b/docs/modules/renderer/implicit/utils.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.implicit.utils +================================= + +utils + +.. automodule:: pytorch3d.renderer.implicit.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/index.rst b/docs/modules/renderer/index.rst index 48dffc31..23459149 100644 --- a/docs/modules/renderer/index.rst +++ b/docs/modules/renderer/index.rst @@ -1,15 +1,19 @@ -pytorch3d.renderer -=========================== +pytorch3d.renderer +================== .. toctree:: - rasterizer + blending + camera_conversions + camera_utils cameras + compositing + fisheyecameras lighting materials - texturing - blending - shading - shader - renderer - utils \ No newline at end of file + splatter_blend + utils + implicit/index + mesh/index + opengl/index + points/index diff --git a/docs/modules/renderer/lighting.rst b/docs/modules/renderer/lighting.rst index e33c22c6..314824de 100644 --- a/docs/modules/renderer/lighting.rst +++ b/docs/modules/renderer/lighting.rst @@ -1,6 +1,9 @@ -lighting +pytorch3d.renderer.lighting =========================== +lighting + .. automodule:: pytorch3d.renderer.lighting :members: - :undoc-members: \ No newline at end of file + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/materials.rst b/docs/modules/renderer/materials.rst index b01d9fd8..c759e573 100644 --- a/docs/modules/renderer/materials.rst +++ b/docs/modules/renderer/materials.rst @@ -1,7 +1,9 @@ +pytorch3d.renderer.materials +============================ + materials -=========================== .. automodule:: pytorch3d.renderer.materials :members: :undoc-members: - :show-inheritance: \ No newline at end of file + :show-inheritance: diff --git a/docs/modules/renderer/mesh/clip.rst b/docs/modules/renderer/mesh/clip.rst new file mode 100644 index 00000000..57d9f78f --- /dev/null +++ b/docs/modules/renderer/mesh/clip.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.mesh.clip +============================ + +clip + +.. automodule:: pytorch3d.renderer.mesh.clip + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/mesh/index.rst b/docs/modules/renderer/mesh/index.rst new file mode 100644 index 00000000..9fccba01 --- /dev/null +++ b/docs/modules/renderer/mesh/index.rst @@ -0,0 +1,13 @@ +pytorch3d.renderer.mesh +======================= + +.. toctree:: + + clip + rasterize_meshes + rasterizer + renderer + shader + shading + textures + utils diff --git a/docs/modules/renderer/mesh/rasterize_meshes.rst b/docs/modules/renderer/mesh/rasterize_meshes.rst new file mode 100644 index 00000000..3f46d3a7 --- /dev/null +++ b/docs/modules/renderer/mesh/rasterize_meshes.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.mesh.rasterize_meshes +======================================== + +rasterize_meshes + +.. automodule:: pytorch3d.renderer.mesh.rasterize_meshes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/mesh/rasterizer.rst b/docs/modules/renderer/mesh/rasterizer.rst new file mode 100644 index 00000000..28cb526e --- /dev/null +++ b/docs/modules/renderer/mesh/rasterizer.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.mesh.rasterizer +================================== + +rasterizer + +.. automodule:: pytorch3d.renderer.mesh.rasterizer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/mesh/renderer.rst b/docs/modules/renderer/mesh/renderer.rst new file mode 100644 index 00000000..54b5682c --- /dev/null +++ b/docs/modules/renderer/mesh/renderer.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.mesh.renderer +================================ + +renderer + +.. automodule:: pytorch3d.renderer.mesh.renderer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/shader.rst b/docs/modules/renderer/mesh/shader.rst similarity index 50% rename from docs/modules/renderer/shader.rst rename to docs/modules/renderer/mesh/shader.rst index 076492bb..694e3df2 100644 --- a/docs/modules/renderer/shader.rst +++ b/docs/modules/renderer/mesh/shader.rst @@ -1,7 +1,9 @@ +pytorch3d.renderer.mesh.shader +============================== + shader -=========================== .. automodule:: pytorch3d.renderer.mesh.shader :members: :undoc-members: - \ No newline at end of file + :show-inheritance: diff --git a/docs/modules/renderer/shading.rst b/docs/modules/renderer/mesh/shading.rst similarity index 50% rename from docs/modules/renderer/shading.rst rename to docs/modules/renderer/mesh/shading.rst index f9bcac4a..90aa3b60 100644 --- a/docs/modules/renderer/shading.rst +++ b/docs/modules/renderer/mesh/shading.rst @@ -1,7 +1,9 @@ +pytorch3d.renderer.mesh.shading +=============================== + shading -=========================== .. automodule:: pytorch3d.renderer.mesh.shading :members: :undoc-members: - + :show-inheritance: diff --git a/docs/modules/renderer/mesh/textures.rst b/docs/modules/renderer/mesh/textures.rst new file mode 100644 index 00000000..7ca173c4 --- /dev/null +++ b/docs/modules/renderer/mesh/textures.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.mesh.textures +================================ + +textures + +.. automodule:: pytorch3d.renderer.mesh.textures + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/mesh/utils.rst b/docs/modules/renderer/mesh/utils.rst new file mode 100644 index 00000000..2944ba84 --- /dev/null +++ b/docs/modules/renderer/mesh/utils.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.mesh.utils +============================= + +utils + +.. automodule:: pytorch3d.renderer.mesh.utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/opengl/index.rst b/docs/modules/renderer/opengl/index.rst new file mode 100644 index 00000000..5bc1f306 --- /dev/null +++ b/docs/modules/renderer/opengl/index.rst @@ -0,0 +1,7 @@ +pytorch3d.renderer.opengl +========================= + +.. toctree:: + + opengl_utils + rasterizer_opengl diff --git a/docs/modules/renderer/opengl/opengl_utils.rst b/docs/modules/renderer/opengl/opengl_utils.rst new file mode 100644 index 00000000..64a86609 --- /dev/null +++ b/docs/modules/renderer/opengl/opengl_utils.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.opengl.opengl_utils +====================================== + +opengl_utils + +.. automodule:: pytorch3d.renderer.opengl.opengl_utils + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/opengl/rasterizer_opengl.rst b/docs/modules/renderer/opengl/rasterizer_opengl.rst new file mode 100644 index 00000000..28cf9646 --- /dev/null +++ b/docs/modules/renderer/opengl/rasterizer_opengl.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.opengl.rasterizer_opengl +=========================================== + +rasterizer_opengl + +.. automodule:: pytorch3d.renderer.opengl.rasterizer_opengl + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/points/compositor.rst b/docs/modules/renderer/points/compositor.rst new file mode 100644 index 00000000..4f97015a --- /dev/null +++ b/docs/modules/renderer/points/compositor.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.points.compositor +==================================== + +compositor + +.. automodule:: pytorch3d.renderer.points.compositor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/points/index.rst b/docs/modules/renderer/points/index.rst new file mode 100644 index 00000000..2eb454d2 --- /dev/null +++ b/docs/modules/renderer/points/index.rst @@ -0,0 +1,10 @@ +pytorch3d.renderer.points +========================= + +.. toctree:: + + compositor + rasterize_points + rasterizer + renderer + pulsar/index diff --git a/docs/modules/renderer/points/pulsar/index.rst b/docs/modules/renderer/points/pulsar/index.rst new file mode 100644 index 00000000..064c518f --- /dev/null +++ b/docs/modules/renderer/points/pulsar/index.rst @@ -0,0 +1,7 @@ +pytorch3d.renderer.points.pulsar +================================ + +.. toctree:: + + renderer + unified diff --git a/docs/modules/renderer/points/pulsar/renderer.rst b/docs/modules/renderer/points/pulsar/renderer.rst new file mode 100644 index 00000000..21956612 --- /dev/null +++ b/docs/modules/renderer/points/pulsar/renderer.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.points.pulsar.renderer +========================================= + +renderer + +.. automodule:: pytorch3d.renderer.points.pulsar.renderer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/points/pulsar/unified.rst b/docs/modules/renderer/points/pulsar/unified.rst new file mode 100644 index 00000000..f5cc4938 --- /dev/null +++ b/docs/modules/renderer/points/pulsar/unified.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.points.pulsar.unified +======================================== + +unified + +.. automodule:: pytorch3d.renderer.points.pulsar.unified + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/points/rasterize_points.rst b/docs/modules/renderer/points/rasterize_points.rst new file mode 100644 index 00000000..1e61f9d0 --- /dev/null +++ b/docs/modules/renderer/points/rasterize_points.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.points.rasterize_points +========================================== + +rasterize_points + +.. automodule:: pytorch3d.renderer.points.rasterize_points + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/points/rasterizer.rst b/docs/modules/renderer/points/rasterizer.rst new file mode 100644 index 00000000..1b5e2aa9 --- /dev/null +++ b/docs/modules/renderer/points/rasterizer.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.points.rasterizer +==================================== + +rasterizer + +.. automodule:: pytorch3d.renderer.points.rasterizer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/points/renderer.rst b/docs/modules/renderer/points/renderer.rst new file mode 100644 index 00000000..57e9fd30 --- /dev/null +++ b/docs/modules/renderer/points/renderer.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.points.renderer +================================== + +renderer + +.. automodule:: pytorch3d.renderer.points.renderer + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/rasterizer.rst b/docs/modules/renderer/rasterizer.rst deleted file mode 100644 index f6dfa1fd..00000000 --- a/docs/modules/renderer/rasterizer.rst +++ /dev/null @@ -1,10 +0,0 @@ -rasterizer -=========================== - -.. automodule:: pytorch3d.renderer.mesh.rasterize_meshes - :members: - :undoc-members: - -.. automodule:: pytorch3d.renderer.mesh.rasterizer - :members: - :undoc-members: \ No newline at end of file diff --git a/docs/modules/renderer/splatter_blend.rst b/docs/modules/renderer/splatter_blend.rst new file mode 100644 index 00000000..d092dc2b --- /dev/null +++ b/docs/modules/renderer/splatter_blend.rst @@ -0,0 +1,9 @@ +pytorch3d.renderer.splatter_blend +================================= + +splatter_blend + +.. automodule:: pytorch3d.renderer.splatter_blend + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/renderer/texturing.rst b/docs/modules/renderer/texturing.rst deleted file mode 100644 index 2375a5fe..00000000 --- a/docs/modules/renderer/texturing.rst +++ /dev/null @@ -1,7 +0,0 @@ -texturing -=========================== - -.. automodule:: pytorch3d.renderer.mesh.texturing - :members: - :undoc-members: - \ No newline at end of file diff --git a/docs/modules/renderer/utils.rst b/docs/modules/renderer/utils.rst index 9c96613d..a196433c 100644 --- a/docs/modules/renderer/utils.rst +++ b/docs/modules/renderer/utils.rst @@ -1,6 +1,9 @@ +pytorch3d.renderer.utils +======================== + utils -=========================== .. automodule:: pytorch3d.renderer.utils :members: - :undoc-members: \ No newline at end of file + :undoc-members: + :show-inheritance: diff --git a/docs/modules/vis.rst b/docs/modules/vis.rst deleted file mode 100644 index e6626856..00000000 --- a/docs/modules/vis.rst +++ /dev/null @@ -1,6 +0,0 @@ -pytorch3d.vis -=========================== - -.. automodule:: pytorch3d.vis - :members: - :undoc-members: diff --git a/docs/modules/vis/index.rst b/docs/modules/vis/index.rst new file mode 100644 index 00000000..79e1bda1 --- /dev/null +++ b/docs/modules/vis/index.rst @@ -0,0 +1,7 @@ +pytorch3d.vis +============= + +.. toctree:: + + plotly_vis + texture_vis diff --git a/docs/modules/vis/plotly_vis.rst b/docs/modules/vis/plotly_vis.rst new file mode 100644 index 00000000..2380a7b1 --- /dev/null +++ b/docs/modules/vis/plotly_vis.rst @@ -0,0 +1,9 @@ +pytorch3d.vis.plotly_vis +======================== + +plotly_vis + +.. automodule:: pytorch3d.vis.plotly_vis + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/modules/vis/texture_vis.rst b/docs/modules/vis/texture_vis.rst new file mode 100644 index 00000000..5e59744e --- /dev/null +++ b/docs/modules/vis/texture_vis.rst @@ -0,0 +1,9 @@ +pytorch3d.vis.texture_vis +========================= + +texture_vis + +.. automodule:: pytorch3d.vis.texture_vis + :members: + :undoc-members: + :show-inheritance: