Use Furo's navigation component through sphinx-design-elements' linktree

[amotl]

About

What the title says. Still WIP.

Preview

• https://crate-docs-theme--405.org.readthedocs.build/en/405/

References

• Add "link tree" element, using directive linktree tech-writing/sphinx-design-elements#11

[bmunkholm]

@amotl Do you recall what was left to make this work?

[amotl]

Hi Brian,

currently, it's just an alpha / proof-of-concept, but ready enough that I was satisfied for the time being. Possibly not much is missing, but I lost track, and I guess you know about the pareto thing and its 80/20 rule mostly related to getting the nitty gritty details right.

First, we need to wrap up tech-writing/sphinx-design-elements#11, then this one. Do you think there would be a benefit by having better composition of toctrees, like @robtaylor stated at tech-writing/sphinx-design-elements#11 (comment)?

I was looking for intersphinx support in toctree, but also better composition of toctrees would be a great help!

I mean, of course it's a rhetorical question, because I think the tracking ticket makes it clear this feature would be something the community could benefit from, and without the mix of our and other's needs, I wouldn't have bothered to explore this topic.

• Discussing and shaping the linktree directive tech-writing/sphinx-design-elements#14

So, let's phrase my question differently: Do you think it's finally time to wrap up this proof-of-concept into shippable software, possibly just in time for Christmas?

With kind regards,
Andreas.

[amotl]

I've tried to assemble this yesterday to see what's missing....

[amotl]

... and encountered an "unexpected" exception on CI:

ImportError: cannot import name 'TocTree' from 'sphinx.environment'

-- https://github.com/crate/crate-docs-theme/actions/runs/20082409491/job/57612387226?pr=405#step:7:492

[amotl]

Well, this doesn't mean much, because it's all just a draft, originally conceived more than two years ago. However, it highlights that software parts currently do NOT fit together well, so the package needs some more love. A little import error per se is nothing to worry about, I am sure there might be the one or the other different obstacle along the way to general availability.

[bmunkholm]

I suggested a fix for the build issue. But yeah, looking at the code and the amount of remaining todos, it seems there still is quite a bit of work left? While this is likely a better way, it's probably a bit too involved for me at this moment.