Add support for toctree captions #620
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I do not know if that was supported with doctrine/rst-parser, but there is such a thing as a caption option for the toctree directive, and it seems that phpDocumentor/guides supports it. When I tried it, it produced a "p" element with a caption class. Adding support for that means we could get rid of the toc and tocheader directives. These custom directives appear to be the directives that cause the most unfixable warnings (unfixable without a custom guides extension, that is). We might end up with an extension anyway if there are other warnings, but I think this could be a nice simplification.
greg0ire
force-pushed
the
support-menu-caption
branch
from
220feb1 to
71da777
Compare
SenseException
approved these changes
Oct 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I do not know if that was supported with
doctrine/rst-parser, but there is such a thing as a caption option for thetoctreedirective, and it seems thatphpDocumentor/guidessupports it.When I tried it, it produced a
pelement with acaptionclass. Adding support for that means we could get rid of thetocandtocheaderdirectives.These custom directives appear to be the directives that cause the most unfixable warnings (unfixable without a custom guides extension, that is).
We might end up with an extension anyway if there are other warnings, but I think this could be a nice simplification.