Skip to content

docs: Clarify custom_templates folder location in options documentation - #474

Merged
pawamoy merged 2 commits into
mkdocstrings:masterfrom
KSneijders:master
Sep 23, 2022
Merged

pawamoy merged 2 commits into
mkdocstrings:masterfrom
KSneijders:master

Conversation

@KSneijders

Copy link
Copy Markdown
Contributor

A small PR to (in my opinion) improve the clarity of the custom_templates config option.
The reason for this is that when I read the current line:

the path to a directory containing custom templates. The path is relative to the docs directory

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 docs in 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.

@KSneijders KSneijders changed the title Clarify custom_templates folder location in options documentation [Docs] Clarify custom_templates folder location in options documentation Sep 4, 2022
@KSneijders KSneijders changed the title [Docs] Clarify custom_templates folder location in options documentation docs: Clarify custom_templates folder location in options documentation Sep 4, 2022
@pawamoy

pawamoy commented Sep 10, 2022

Copy link
Copy Markdown
Member

Hi @KSneijders, thank you for your help on improving the docs!

Actually, it seems the custom_templates value is relative to the current working directory, which should be fixed to make it relative to the mkdocs.yml file instead. I'll open a new issue.

@pawamoy

pawamoy commented Sep 10, 2022 •

Copy link
Copy Markdown
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?

@KSneijders

Copy link
Copy Markdown
Contributor Author

Hey @pawamoy!
Thanks for the response! It being relative to the CWD explains a lot.
I've changed the explanation to a simple line without example as the CWD could be different for everyone which makes it difficult to give examples.

@pawamoy

pawamoy commented Sep 23, 2022

Copy link
Copy Markdown
Member

Thank you for the update, LGTM, merging 🙂

@pawamoy
pawamoy merged commit efa00b2 into mkdocstrings:master Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants