Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Nested rst:directive:option is un-nested in TOC #10827

Closed
mgeier opened this issue Sep 13, 2022 · 0 comments · Fixed by #10828
Closed

Nested rst:directive:option is un-nested in TOC #10827

mgeier opened this issue Sep 13, 2022 · 0 comments · Fixed by #10828
Labels
Milestone

Comments

@mgeier
Copy link
Contributor

mgeier commented Sep 13, 2022

Describe the bug

Follow-up to #10807 (comment).

How to Reproduce

conf.py:

# empty

index.rst:

Hello!
======

.. toctree::

   rst

rst.rst:

reST Domain
===========

This example is taken from
https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#directive-rst-directive-option:

.. rst:directive:: toctree

   .. rst:directive:option:: caption: caption of ToC

   .. rst:directive:option:: glob

Expected behavior

Since rst:directive:option is nested within rst:directive, I would expect it's TOC entry to be nested as well.

Your project

https://insipid-sphinx-theme.readthedocs.io/en/sphinx5.x/showcase/api-doc.html

Screenshots

image

OS

any

Python version

any

Sphinx version

5.x branch, after #10807

Sphinx extensions

No response

Extra tools

No response

Additional context

No response

@AA-Turner AA-Turner added this to the 5.2.0 milestone Sep 14, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 21, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants