✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

_{Generated for commit: b0f84bb. Link to the linter CI: here}

Just to confirm @ogrisel, do you mean that we should keep the .. toctree:: at the top of the page while removing the backlinks of the headers? (This could be a bit difficult and I need to do further investigations.)

ping @ogrisel

Just to confirm @ogrisel, do you mean that we should keep the .. toctree:: at the top of the page while removing the backlinks of the headers? (This could be a bit difficult and I need to do further investigations.)

Yes. But if that's too cumbersome/hackish to implement let's keep it the way it is in this PR.

Thanks for the clarification @ogrisel. AFAIK there is not an option of the .. toctree:: directive that let us easily remove the backlinks. Two possible ways that I can think of are: (1) implement our own directive and there should be some way to resolve the in-page toctree; (2) use a post transform to steal the toctree built by pydata-sphinx-theme and put it in the main page. But as you said they might be too hackish just for this purpose.

I think I do miss the ToC on top of the page. I personally wouldn't mind having the ToC on top, AND have the usual pydata theme navbar on the right side. Would that be okay?

@adrinjalali Yes that's perfectly okay.

The tradeoff is in fact "keeping the TOC at the top of the page" will cause "backlinks to be generated for the titles which does not look good".

I however made a mistake in the previous comment: the statement there is no trivial way to remove backlink styles is incorrect. In CSS there are pointer-events: none that disables any click events and text-decoration: none that removes link underlines. (Earlier I put those on the h2 and h3 elements (stupid mistake) and found that the backlink styles are not reverted, but I should have put those styles on the anchor elements inside them. 😭)

Well anyways, I think the latest version would resolve all the mentioned problems. Also ping @ogrisel if you want to take another look. https://output.circle-artifacts.com/output/job/f3d31074-de89-4934-8c65-c1c8bbe171c2/artifacts/0/doc/faq.html

I think text-decoration: none is enough. No need to remove the actual backlinks clicking behavior.

I think text-decoration: none is enough. No need to remove the actual backlinks clicking behavior.

On second thought I agree. Now I only kept text-decoration: none and removed the color and pointer-events rules.

https://output.circle-artifacts.com/output/job/335dffa0-d8c4-4d70-a396-d156d96c83e4/artifacts/0/doc/faq.html