-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Closed
Description
In a project where the documentation files are located under docs/
, it seems that files inside a sub-directory called templates/
(path being docs/templates/
) are reported as missing when referring to them in the configuration file.
The configuration is like:
<redacted>
nav:
- Introduction: 'index.md'
- Templating:
- Writing Templates: 'templates/index.md'
- Arista EOS: 'templates/arista-eos.md'
- Cisco IOS-XR: 'templates/cisco-iosxr.md'
- Juniper JUNOS: 'templates/juniper-junos.md'
- Peering Request E-mail: 'templates/peering-request-email.md'
<redacted>
When trying to build
or serve
, the following warning are raised (using mkdocs >= 1.0
).
WARNING - A relative path to 'templates/index.md' is included in the 'nav' configuration, which is not found in the documentation files
WARNING - A relative path to 'templates/arista-eos.md' is included in the 'nav' configuration, which is not found in the documentation files
WARNING - A relative path to 'templates/cisco-iosxr.md' is included in the 'nav' configuration, which is not found in the documentation files
WARNING - A relative path to 'templates/juniper-junos.md' is included in the 'nav' configuration, which is not found in the documentation files
WARNING - A relative path to 'templates/peering-request-email.md' is included in the 'nav' configuration, which is not found in the documentation files
Please note that the docs/
directory is also at the same level in the file system than another directory called templates/
. So from a file system perspective it looks like:
docs/
`---- index.md
`---- templates/
somedir/
someotherdir/
templates/
Is it a normal behavior or is it a corner case?
bjschafer, NiklasRosenstein and kmontocam