API Documentation have a flattened list of all the modules and classes

[ekzhu]

Just a flattened list of all the modules and classes that is ordered by full module name.

[gagb]

I tried to do this. One solution is to set the left padding of the ul element in the side navbar, but the challenges is that changes the global settings.

A better solution is to add a class to the API reference page, and selectively apply this CSS modifier. But I for love of god can't figure out how to do that.

The toctree lives outside the main page content, so adding :class: to toctree definition in reference/index.md does not work. Similarly wrapping the contents of the same index.md in a <div class="reference"></div> does not work.

I worry that the best solution maybe to create a custom toctree, somehow. But I am not at all sure how to do that. cc @jackgerrits

It's really worth doing it tho, this is what our page would look like. It's much much more readable. cc @afourney

[afourney]

Agree. Principle at hand is recognition over recall.

[ekzhu]

Ah not done yet. The page with a flattened list of all classes is still not there.

[jackgerrits]

Not sure if we can do this within the same site or not. Essentially it would break all of the anchors and class references etc, as now there would be two locations of the docs.

We could generate a new site and host it under a new directory but thats a bit confusing.

There's a builder which outputs the whole website as one big html file. It's pretty cool to see, but again not sure where we would host it in a way that makes sense for navigation.

Attaching it here for curiosity though: build-single-html.zip

Overall I'm not sure how to pull this off in a way that doesn't break things or duplicate things in a confusing way.

[ekzhu]

Moving this to the next release.