Skip to content

Commit 1040d3b

Browse files
committed
DOC: Mention index.ipynb as alternative to index.rst
1 parent af3a94c commit 1040d3b

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

doc/usage.ipynb

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,19 @@
4040
"\n",
4141
"For an example, see this project's [conf.py](conf.py) file.\n",
4242
"\n",
43-
"Once your `conf.py` is in place, edit the file named `index.rst` and add the file names of your notebooks (without the `.ipynb` extension) to the [toctree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) directive.\n",
44-
"For an example, see this project's `doc/index.rst` file."
43+
"Once your `conf.py` is in place,\n",
44+
"edit the file named `index.rst` and add the file names of your notebooks\n",
45+
"(without the `.ipynb` extension)\n",
46+
"to the\n",
47+
"[toctree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree)\n",
48+
"directive.\n",
49+
"For an example, see this project's `doc/index.rst` file.\n",
50+
"\n",
51+
"Alternatively, you can delete the file `index.rst`\n",
52+
"and replace it with your own notebook called `index.ipynb`\n",
53+
"which will serve as main page.\n",
54+
"In this case you can create the main [toctree](subdir/toctree.ipynb)\n",
55+
"in `index.ipynb`."
4556
]
4657
},
4758
{

0 commit comments

Comments
 (0)