Conversation
Fix bypassing it when: * a non-absolute config_file_path is passed on the command line * the directory is not an *exact* parent of the other one, but is instead a "grandparent". Also validate it in `mkdocs serve` because why reserve the check only to `mkdocs build`.
This comment was marked as abuse.
This comment was marked as abuse.
|
I think the site_dir message is good. I'm not sure I follow what use case you're protecting against to warn against the mkdocs.yml file inside of the docs dir. Previously mkdocs required the docs dir to be located in a child directory named 'docs', but since you can now specify the config from the command line, I don't believe this is the case any more? |
This comment was marked as abuse.
This comment was marked as abuse.
|
Ah, ok. Makes sense then. |
|
Would you consider making it a warning instead of an error? |
This comment was marked as abuse.
This comment was marked as abuse.
|
Yeah, if you want to do something like #3526 so excluded docs aren't triggering the reload server but you want to have mkdocs.yml trigger it, you might want to not add it to |
|
Eh, nevermind. I think I found a clean way of handling that case. An error sounds fine to me. |
This comment was marked as abuse.
This comment was marked as abuse.
|
Who are the next maintainers? |
|
Right now, they are the people in the @mkdocs/core team who have the time and will to work on MkDocs :) As you know it, we're also trying to onboard more people. |
This comment was marked as abuse.
This comment was marked as abuse.
|
Would love this to be picked up and merged. I want to keep docs in the root directory so github displays it. |
|
Is there any additional features/feedback needed for this to merge? I can help update on the code side if needed |
|
It would be great to support this in mkdocs replacing the plugin mkdocs-same-dir and also fix compatibility with mkdocs-awesome-nav. I can help with adapting and testing this. Any update from maintainers if it makes sense to proceed or some alternative way? /cc @nihalshah-dev |
If the config file is inside docs_dir, you get this message:
If the site_dir is inside docs_dir, you get this message: