Skip to content

Commit e5d0082

Browse files
authored
Update README.md
1 parent 55abce9 commit e5d0082

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -143,12 +143,12 @@ directory. Use one of the following templates:
143143
- [Markdown template](https://github.com/pytorch/executorch/blob/main/docs/source/tutorial-template.md)
144144

145145
After creating a tutorial, make sure to add the corresponding path in the
146-
[index.rst](source/index.md) file in the following places:
146+
[index.md](source/index.md) file in the following places:
147147

148148
- In the
149-
[tutorials torctree](https://github.com/pytorch/executorch/blob/main/docs/source/index.rst?plain=1#L183)
149+
[tutorials torctree](https://github.com/pytorch/executorch/blob/main/docs/source/index.md?plain=1#L185)
150150
- In the
151-
[customcard section](https://github.com/pytorch/executorch/blob/main/docs/source/index.rst?plain=1#L201)
151+
[customcard section](https://github.com/pytorch/executorch/blob/main/docs/source/index.md?plain=1#L201)
152152

153153
If you want to include a Markdown tutorial that is stored in another directory
154154
outside of the `docs/source` directory, complete the following steps:
@@ -163,7 +163,7 @@ outside of the `docs/source` directory, complete the following steps:
163163

164164
**NOTE:** Your tutorial source file needs to follow the tutorial template.
165165

166-
3. Add the file that you have created in **Step 1** to the `index.rst` toctree
166+
3. Add the file that you have created in **Step 1** to the `index.md` toctree
167167
and add a `customcarditem` with the link to that file.
168168

169169
For example, if I wanted to include the `README.md` file from
@@ -176,7 +176,7 @@ file:
176176
```{include} ../../../examples/selective_build/README.md
177177
````
178178

179-
In the `index.rst` file, I would add `tutorials/selective-build-tutorial` in
179+
In the `index.md` file, I would add `tutorials/selective-build-tutorial` in
180180
both the `toctree` and the `cusotmcarditem` sections.
181181

182182
# Auto-generated API documentation
@@ -211,7 +211,7 @@ executorch.exir
211211
```
212212

213213
These separate `.rst` files should all be linked together, with the initial
214-
landing page under `index.rst`.
214+
landing page under `index.md`.
215215

216216
### C++ APIs
217217

@@ -236,4 +236,4 @@ important/relevant parts are:
236236

237237
If you need to include new files, simply add them to the `INPUT` in the
238238
`Doxyfile`. The generated output is included to the ExecuTorch documentation
239-
build and referenced in `index.rst`.
239+
build and referenced in `index.md`.

0 commit comments

Comments
 (0)