Set toc_object_entries=True to auto add functions/classes to the page's table of contents?

Been reflecting and I think the @accessibility team should consult here

Folks who use assistive technologies/screen-readers would have to navigate the page differently if we remove headers (they would navigate via lists/list items instead <dl>, <dt>…).

I also think the indents impact where the information is structured in the HTML and we should perhaps get guidance on this.

Hence, I would love the accessibility team to review the options available as to how we can structure the reference docs and advise us on the best result in terms of a good table of contents and a good screen reader experience.

We can then add that to the contributing guide and work towards it. :+1:

1 Like