isl-org / Open3D

Open3D: A Modern Library for 3D Data Processing
http://www.open3d.org
Other
11.32k stars 2.29k forks source link

Request to enhance open3d Documentation with Embed 3D Model Feature #6209

Open saurabheights opened 1 year ago

saurabheights commented 1 year ago

Checklist

Proposed new feature or change

As the open3d library primarily focuses on 3D data, incorporating an embed 3D model feature from platforms like Sketchfab or similar websites to Open3D documentation would offer users an immersive and interactive experience while learning and exploring the library's capabilities.

2D Images are not always as informative and while a video of rendering with an encompassing trajectory around the object is helpful, it doesnt provide as immersive solution as 3D data.

p.s. Please add documentation label.

References

https://help.sketchfab.com/hc/en-us/articles/203509907-Embedding-your-3D-models

Additional information

No response

saurabheights commented 1 year ago

Example - https://zju3dv.github.io/neuralrecon/

Pranshul-art commented 11 months ago

sir i want to work on this but i am a fresher on open source , so sir can you please guide me with what i have to do and where i can find more details about this which would be necessary.

Pranshul-art commented 11 months ago

@saurabheights

saurabheights commented 11 months ago

@Pranshul-art Whatever you read here is strongly my personal opinion.

This probably is not gonna be a simple PR if you are a newbie. Furthermore, the return of the effort will be very little. I will strongly advise against it for now. See last para on other ideas that you can work on right now.

If you still want to work on this, first understand current documentation pipeline which uses sphinx and open3d_sphinx_theme. Now, for adding a sketchfab content to one of these tutorials, you will have to first see how to embed it into notebook and later this should be in generated web documentation. See https://stackoverflow.com/questions/46053005/how-to-create-a-custom-html-div-in-sphinx-that-isnt-automatically-nested-within which shows how to add custom html div code in RST files (how to do it in notebook would require more deepdive, since RST file is autogenerated from python notebook for many of the tutorials).

Next, regarding Sketchfab, save generated models somewhere in https://github.com/isl-org/open3d_downloads if its not saved already there. Ask repo maintainers to make an account on sketchfab and get the 3d model artifacts uploaded there. Use public url for sketchfab models in the documentation.

Ideally, if you want to improve docs, there are few major issues IMO :-

  1. Documentation Tech Stack - sphinx/sphinx-extensions/sphinx-theme packages are quite old. Forks like https://github.com/isl-org/open3d_sphinx_theme havent been updated for a long time. It was forked from sphinx_rtd_theme version 0.4.3 and latest sphinx_rtd_theme version is 2.0 and as you can see a lot of new improvements were added in changelog.
  2. Content Improvement: