Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Clarify custom_templates folder location in options documentation #474

Merged
merged 2 commits into from Sep 23, 2022
Merged

Conversation

KSneijders
Copy link
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
Copy link
Member

pawamoy commented Sep 10, 2022

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
Copy link
Member

pawamoy commented Sep 10, 2022

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
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
Copy link
Member

pawamoy commented Sep 23, 2022

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.

None yet

2 participants