mirror of
https://github.com/facebookresearch/pytorch3d.git
synced 2025-12-17 12:50:35 +08:00
Website and docs updates
Summary: - Added sbranson's fit mesh tutorial to the website - Updated rendering docs with info about texturing and new shader types. TODO: - add pointcloud rendering tutorial to the website as well (https://github.com/facebookresearch/pytorch3d/blob/master/docs/tutorials/render_colored_points.ipynb) - docs for camera - update some tutorials which depended on the Textures from structures. Reviewed By: gkioxari Differential Revision: D23143977 fbshipit-source-id: 6843c9bf3ce11115c459c64da5b0ad778dc92177
This commit is contained in:
committed by
Facebook GitHub Bot
parent
9a50cf800e
commit
d330765847
@@ -2,7 +2,7 @@ This website was created with [Docusaurus](https://docusaurus.io/).
|
||||
|
||||
# Building the PyTorch3D website
|
||||
|
||||
## Install
|
||||
## Install
|
||||
|
||||
1. Make sure all the dependencies for the website are installed:
|
||||
|
||||
@@ -10,7 +10,7 @@ This website was created with [Docusaurus](https://docusaurus.io/).
|
||||
# Install dependencies
|
||||
$ yarn
|
||||
|
||||
or
|
||||
or
|
||||
|
||||
$ npm install docusaurus-init
|
||||
```
|
||||
@@ -40,7 +40,7 @@ Install yarn:
|
||||
```
|
||||
brew install yarn
|
||||
|
||||
# or
|
||||
# or
|
||||
|
||||
curl -o- -L https://yarnpkg.com/install.sh | bash
|
||||
```
|
||||
@@ -57,11 +57,11 @@ This will build the docusaurus website and run a script to parse the tutorials a
|
||||
- `.py`/`.ipynb` files in the `website/static/files` folder
|
||||
|
||||
|
||||
TODO: Add support for latex in markdown in jupyter notebooks and embedded images.
|
||||
TODO: Add support for latex in markdown in jupyter notebooks and embedded images.
|
||||
|
||||
## Build and publish the website
|
||||
|
||||
The following script will build the tutorials and the website and push to the gh-pages
|
||||
The following script will build the tutorials and the website and push to the gh-pages
|
||||
branch of `github.com/facebookresearch/pytorch3d`.
|
||||
|
||||
```
|
||||
@@ -71,17 +71,17 @@ bash scripts/publish_website.sh
|
||||
|
||||
## Add a new tutorial
|
||||
|
||||
The tutorials to include in the website are listed in `website/tutorials.json`. If you create a new tutorial add an entry to the list in this file. This is needed in order to generate the sidebar for the tutorials page.
|
||||
The tutorials to include in the website are listed in `website/tutorials.json`. If you create a new tutorial add an entry to the list in this file. This is needed in order to generate the sidebar for the tutorials page.
|
||||
|
||||
|
||||
## Edit the landing page
|
||||
|
||||
To change the content of the landing page modify: `website/pages/en/index.js`.
|
||||
To change the content of the landing page modify: `website/pages/en/index.js`.
|
||||
|
||||
|
||||
## Edit the tutorials page
|
||||
|
||||
To change the content of the tutorials home page modify: `website/pages/tutorials/index.js`.
|
||||
To change the content of the tutorials home page modify: `website/pages/tutorials/index.js`.
|
||||
|
||||
|
||||
---------------------------------------------------------
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
{
|
||||
"docs": {
|
||||
"Introduction": ["why_pytorch3d"],
|
||||
"Meshes": ["batching", "meshes_io"],
|
||||
"Differentiable Renderer": ["renderer", "renderer_getting_started"]
|
||||
"Data": ["meshes_io", "datasets", "batching"],
|
||||
"Ops": ["cubify"],
|
||||
"Renderer": ["renderer", "renderer_getting_started", "cameras"]
|
||||
}
|
||||
}
|
||||
|
||||
@@ -12,9 +12,18 @@
|
||||
{
|
||||
"id": "render_textured_meshes",
|
||||
"title": "Render Textured Meshes"
|
||||
},{
|
||||
"id": "fit_textured_mesh",
|
||||
"title": "Fit a mesh with texture via rendering"
|
||||
}, {
|
||||
"id": "camera_position_optimization_with_differentiable_rendering",
|
||||
"title": "Camera Position Optimization"
|
||||
"title": "Camera Position Optimization"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"Dataloaders": [
|
||||
{
|
||||
"id": "dataloaders_ShapeNetCore_R2N2",
|
||||
"title": "Data loaders for ShapeNetCore and R2N2"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user