Add contents entries for object & :nocontentsentry: #43
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This allows to automatically add entries for domain objects in contents table with Sphinx >= 5.2.
See sphinx-doc/sphinx#10807 and sphinx-doc/sphinx#10886
See also an example here with my (still small) documentation : https://club-1.github.io/sphinx-inventory-parser/index.html
(I didn't add the
php:namespace
in my docs as it caused issues with:php:attr:
references for some reason, I will open an issue (and/or a PR) for this bug soon)No namespace
toc_object_entries_show_parents = hide
toc_object_entries_show_parents = domain
toc_object_entries_show_parents = all
Same results as
toc_object_entries_show_parents = domain
With namespace
toc_object_entries_show_parents = hide
toc_object_entries_show_parents = domain
toc_object_entries_show_parents = all
the default theme does not support it very well 😅