Add class option to toctree directive

[timhoffm]

This is a common option for directives (https://docutils.sourceforge.io/docs/ref/rst/directives.html#common-options).

Implementation: The class is added to there toctree-wrapper element, so that

.. toctree::
   :class: some-class

is equivalent to

.. rst-class:: some-class
.. toctree::

[AA-Turner]

Looks reasonable, my only reservation would be adding the class to toctree-wrapper instead of the actual node.

A

[AA-Turner]

Suggested change

	text = (".. toctree::\n"
	" :class: custom-toc\n"
	"\n"
	" foo\n")
	text = ('.. toctree::\n'
	' :class: custom-toc\n'
	'\n'
	' foo\n')

[timhoffm]

Done. But note that all neighboring examples use double quotes.

[timhoffm]

Looks reasonable, my only reservation would be adding the class to toctree-wrapper instead of the actual node.

My reasoning was

• This is what an external .. rst-class:: directive would do to toctree
• It's simpler to select children (.custom-toc [child-selector]) rather than parents ("a node which has a child with .custom-toc class" - I suppose that's possible through the relatively new has(), but would have to look it up)

But if you say the actual node should be used, I can change that. I don't have enough insight why the wrapper is there and whether it should be considered or skipped.

[AA-Turner]

Seems that it was added in #129, see https://www.sphinx-doc.org/en/master/changes.html#id3196 (fifth bullet under "HTML output"). Regardless, I think your logic makes sense.

A

[AA-Turner]

Thanks Tim!

A