Add mkdocs-macros plugin #667
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
llucax
force-pushed
the
mkdocs-macros
branch
3 times, most recently
from
ba13ed0 to
2a8b703
Compare
This was referenced Sep 15, 2023
llucax
force-pushed
the
mkdocs-macros
branch
from
2a8b703 to
f4932fe
Compare
This plugin allow us to avoid repetition by defining variables that can be used throughout the documentation or even functions to automate certain things. Signed-off-by: Leandro Lucarella <[email protected]>
Now documentation, both in `docs/` or in the code, can link to glossary
terms by just using `{{glossary("Term")}}`.
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
Signed-off-by: Leandro Lucarella <[email protected]>
A built-in feature of `mkdocs-material` is used instead. Signed-off-by: Leandro Lucarella <[email protected]>
The README.md file is not included in the documentation anymore, so there is no need to watch it for changes. Signed-off-by: Leandro Lucarella <[email protected]>
llucax
force-pushed
the
mkdocs-macros
branch
from
f4932fe to
634cd50
Compare
`pip` doesn't come installed by default in some systems, so it's better to link to the official instructions to install it. Signed-off-by: Leandro Lucarella <[email protected]>
daniel-zullo-frequenz
approved these changes
Sep 18, 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.
This plugin allow us to avoid repetition by defining variables that can be used throughout the documentation or even functions to automate certain things.
Also add a mkdocs macro to link to the glossary. Documentation in both
docs/or the code can link to glossary terms by just using{{glossary("Term")}}.