Allow using macros in docstrings #687
Merged
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
github-actions
bot
added
part:docs
According to @pawamoy: > `mkdocs-macros` and `mkdocstrings` work at different levels: > `mkdocs-macros` at the plugin level (in something like the > `on_page_markdown` hook) while `mkdocstrings` renders docstrings at > the Markdown conversion level, so in-between `on_page_markdown` and > `on_page_content`. That means `mkdocs-macros` never sees the > docstrings. To fix this, we can implement a hack to plug both together in the `define_env()` function for `mkdocs-macros`. Eventually a `mkdocs-macros` *pluglet* might be implemented so that this hack is not necessary anymore. For more context see: * mkdocstrings/mkdocstrings#615 Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
fix-macros-docstrings
branch
from
f4ba8ef to
fac06af
Compare
matthias-wende-frequenz
approved these changes
Sep 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
According to @pawamoy:
To fix this, we can implement a hack to plug both together in the
define_env()function formkdocs-macros.Eventually a
mkdocs-macrospluglet might be implemented so that this hack is not necessary anymore.For more context see:
mkdocs-macrosmkdocstrings/mkdocstrings#615