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

Allow domain nesting in TOC #13184

Open
minijackson opened this issue Dec 19, 2024 · 0 comments
Open

Allow domain nesting in TOC #13184

minijackson opened this issue Dec 19, 2024 · 0 comments
Labels
type:proposal a feature suggestion

Comments

@minijackson
Copy link

Is your feature request related to a problem? Please describe.

I'm developing a Nix domain for Sphinx, and before Sphinx 7.4.0 I've been able to use domain-defined nesting, which changed in #12367. Documenting NixOS options is kinda like documenting a JSON schema, where the keys can be heavily nested, so nesting them in document doesn't look good.

Here's an example of what I did with Sphinx 7.3.7 that I can't reproduce in 7.4.0+: https://minijackson.github.io/sphinxcontrib-nixdomain/examples/rst-autodoc-example.html#using-automodule

Describe the solution you'd like
A partial revert of #12367, where it would be somehow possible to choose between document nesting or domain nesting in the TOC.

Describe alternatives you've considered

Put the full name of each object in the TOC, but I find it way less readable.

Additional context

Before #12367:

20241219_11h22m04s_grim

After #12367 and showing the full name in the TOC:

20241219_11h23m34s_grim

@minijackson minijackson added the type:proposal a feature suggestion label Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:proposal a feature suggestion
Projects
None yet
Development

No branches or pull requests

1 participant