Skip to content

"Files not present in docs directory" message shown for external links #1564

@edmorley

Description

@edmorley

Hi!

STR

  1. mkvirtualenv mkdocs -p python 3.6
  2. pip install mkdocs==1.0b1
  3. Update an existing project's mkdocs.yml to use nav and take advantage of external link support. eg:
docs_dir: 'docs'
site_dir: 'build'
strict: true
theme:
  name: 'material'
# ...

nav:
  - Introduction: './index.md'
  # <snip>
  - v8 Documentation: 'https://neutrinojs.org/'
  - v7 Documentation: 'https://release-v7.neutrinojs.org/'
  - v6 Documentation: 'https://github.com/mozilla-neutrino/neutrino-dev/tree/release/v6/docs'
  - v5 Documentation: 'https://github.com/mozilla-neutrino/neutrino-dev/tree/release/v5/docs'
  - v4 Documentation: 'https://github.com/mozilla-neutrino/neutrino-dev/tree/release/v4/docs'
  1. mkdocs serve

Expected

Console output doesn't output warnings that give the impression something is broken.

Actual

(mkdocs) neutrino-dev $ mkdocs serve
INFO    -  Building documentation...
INFO    -  Cleaning site directory
INFO    -  The following paths are included in the "nav" configuration, but do not exist in the docs directory:
  - https://neutrinojs.org/
  - https://release-v7.neutrinojs.org/
  - https://github.com/mozilla-neutrino/neutrino-dev/tree/release/v6/docs
  - https://github.com/mozilla-neutrino/neutrino-dev/tree/release/v5/docs
  - https://github.com/mozilla-neutrino/neutrino-dev/tree/release/v4/docs
[I 180723 17:15:03 server:292] Serving on http://127.0.0.1:8000
...

For links that are clearly external links (ie contain a full URL), it would be good to not output this message (even at log level INFO), since it's likely to be confusing for end users working on our documentation. (Perhaps log level DEBUG is the most appropriate?)

Many thanks :-)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions