feat: navigation button links to enclosing namespace #771
Conversation
This file contains hidden or 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
|
An automated preview of the documentation is available at https://771.mrdocs.prtest2.cppalliance.org/index.html |
| See: https://mrdocs.com/docs/mrdocs/develop/generators.html#dom_reference | ||
| --}} | ||
| {{~#if (and parent parent.name)~}} | ||
| xref:{{{remove_prefix parent.url "/"}}}[⬆] |
Collaborator
There was a problem hiding this comment.
xref is not valid HTML. These common partials are used by both generators. See the other partials in this folder.
| Breadcrumbs are included in the symbol template as an alternative. | ||
| }} | ||
| = {{> symbol/qualified-name symbol }} | ||
| = {{> symbol/enclosing-namespace symbol }}{{> symbol/qualified-name symbol }} |
Collaborator
There was a problem hiding this comment.
This worsens things because we have removed the links to other enclosing namespaces, which the qualified-name partial does. It's removing a feature rather than including one.
Collaborator
There was a problem hiding this comment.
I was surprised the test files didn't change. I think it's because tests bypass the wrapper. But losing this information about the enclosing namespaces in real documentation like Boost.URL sure looks bad.
Collaborator
|
See #469 (comment) |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Fixes #469
It took me quite a while to investigate where the SVG "house" icon is being generated.
I explored various parts of the codebase and toolchain but couldn't locate it. As of now, I still don’t know if this behavior can be modified. Based on my research so far, it doesn't seem to be controlled by MrDocs but rather by subsequent tools in the toolchain, such as Antora.
I came up with this change—not ideal, but it’s a starting point to evaluate if it’s acceptable. If it’s not, any pointers on how to control the house icon generation would be much appreciated. As I mentioned, it doesn’t seem to be within the MrDocs repository.