docs: Clarify custom_templates folder location in options documentation#474
Merged
pawamoy merged 2 commits intomkdocstrings:masterfrom Sep 23, 2022
KSneijders:master
Merged
docs: Clarify custom_templates folder location in options documentation#474pawamoy merged 2 commits intomkdocstrings:masterfrom KSneijders:master
custom_templates folder location in options documentation#474pawamoy merged 2 commits intomkdocstrings:masterfrom
KSneijders:master
Conversation
custom_templates folder location in options documentationcustom_templates folder location in options documentation
custom_templates folder location in options documentationcustom_templates folder location in options documentation
Member
|
Hi @KSneijders, thank you for your help on improving the docs! Actually, it seems the |
Member
|
Can you update this PR to say that the custom templates folder is relative to the current working directory instead of the docs one? |
Contributor
Author
|
Hey @pawamoy! |
Member
|
Thank you for the update, LGTM, merging 🙂 |
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
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.
A small PR to (in my opinion) improve the clarity of the
custom_templatesconfig option.The reason for this is that when I read the current line:
I assumed it meant it was relative to within the docs directory.
Only after looking up other repositories with examples I noticed that you have to include
docsin the path if your templates are in that folder.This is not meant to be final, just an example. If this is not the place for the explanation, I don't mind moving it either.