holoviz-dev / nbsite

Build a tested, sphinx-based website from notebooks
https://nbsite.pyviz.org
BSD 3-Clause "New" or "Revised" License
28 stars 13 forks source link

Make documentation more browsable with page ToC #195

Open hyamanieu opened 3 years ago

hyamanieu commented 3 years ago

Moved from https://github.com/holoviz/holoviews/issues/4801

Problem statement

I spend a considerable amount of time on various holoviz documentations (hvplot, holoviews and panel). Navigating on each is not simple as a table of content is lacking to quickly browse the page.

The current left hand side ToC only points to each page, but not subsection.

Describe the solution you'd like

Bokeh's documentation has a flying table of content for the webpage on the right hand side besides the website ToC on the left hand side. This would be the best solution to me. This project uses the pydata-sphinx-theme.

Describe alternatives you've considered

A non flying table of content would also simplify browsing the documentation.

Additional context

See e.g. https://docs.bokeh.org/en/latest/docs/user_guide/data.html#userguide-data with the flying ToC (works only for windows above 1200px wide).

hyamanieu commented 3 years ago

I believe this issue is again in the wrong repo, as you discussed this in nbsite: https://github.com/pyviz-dev/nbsite/pull/191

If I can bring my suggestion: the text is too long IMHO. It could simply say

To make this page fully interactive, right click to download and run it locally.

I think the whole message is passed. It implies that it's not fully interactive there on the page, and tells the user how to run it.

Then there is room for a ToC :) .

jbednar commented 3 years ago

For comparison, here's the current version, which is indeed verbose:

This web page was generated from a Jupyter notebook and not all interactivity will work on this website. Right click to download and run locally for full Python-backed interactivity.

Still, I think it's important to convey the fact that it only looks like a web page, and is really a notebook. How about:

To make this page fully interactive, right click to download and run the underlying Jupyter notebook locally.