spatialaudio / nbsphinx

:ledger: Sphinx source parser for Jupyter notebooks
https://nbsphinx.readthedocs.io/
MIT License
457 stars 130 forks source link

.ipynb as the homepage? #522

Closed ghost closed 3 years ago

ghost commented 3 years ago

Thank you for the awesome extension. I love rendering Plotly plots on my notebook pages... so much so that I want to use an .ipynb file as my homepage. Is this possible?

I tried the following:

The result is the the first item in the toc tree is home.ipynb, but the home and logo buttons still navigate to index.py

Name: nbsphinx
Version: 0.8.0

Name: Sphinx
Version: 3.3.1
mgeier commented 3 years ago

If you want your index.html to be generated from a notebook, just use index.ipynb instead of index.rst.

See also https://nbsphinx.readthedocs.io/en/0.8.0/usage.html#Sphinx-Setup:

Alternatively, you can delete the file index.rst and replace it with your own notebook called index.ipynb which will serve as main page. In this case you can create the main toctree in index.ipynb.

ghost commented 3 years ago

Thank you. Now I remember reading that paragraph last week! Overlooked it.