Hi!
STR
mkvirtualenv mkdocs -p python 3.6
pip install mkdocs==1.0b1
- 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'
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 :-)
Hi!
STR
mkvirtualenv mkdocs -p python 3.6pip install mkdocs==1.0b1navand take advantage of external link support. eg:mkdocs serveExpected
Console output doesn't output warnings that give the impression something is broken.
Actual
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 :-)