search

grame-cncm / faustlibraries

The Faust libraries
https://faustlibraries.grame.fr
188 stars 61 forks source link

Updated to mkdocs 1.5.3 #197

Closed Yoann-Le-Borgne closed 5 days ago

Yoann-Le-Borgne commented 5 days ago

Updated Makefile to force mkdocs to a fixed version. Updated mkdocs/theme/base.html to use jquery-3.6.0.min.js as provided by mkdocs 1.5.3

This prevents numerous errors caused by significant changes in newer mkdocs versions.

sletz commented 5 days ago

Thanks, but I still get those errors:

make build
Contents/Developer/usr/bin/make md
make[1]: Nothing to be done for `md'.
/Applications/Xcode.app/Contents/Developer/usr/bin/make index
make[1]: Nothing to be done for `index'.
mkdocs build
WARNING -  Config value 'title_brand': Unrecognised configuration name: title_brand
INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /Users/letz/Developpements/faustlibraries/docs
INFO    -  DeprecationWarning: A plugin has set File.page to an instance of Page and it got overwritten. The behavior of this will change in MkDocs 1.6.
             File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/mkdocs/structure/nav.py", line 183, in <listcomp>
               _data_to_navigation((key, value), files, config)
             File "/Library/Frameworks/Python.framework/Versions/3.10/lib/python3.10/site-packages/mkdocs/structure/nav.py", line 209, in _data_to_navigation
               warnings.warn(
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
             - index.md
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/demos', it was left as is. Did you mean 'libs/demos.md'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/analyzers/#anamp_follower', it was left as is. Did you mean
           'libs/analyzers.md#anamp_follower'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/analyzers', it was left as is. Did you mean 'libs/analyzers.md'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/analyzers/#anamp_follower', it was left as is. Did you mean
           'libs/analyzers.md#anamp_follower'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/analyzers/#anmth_octave_analyzer', it was left as is. Did you mean
           'libs/analyzers.md#anmth_octave_analyzer'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/analyzers', it was left as is. Did you mean 'libs/analyzers.md'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/analyzers/#anmth_octave_analyzer', it was left as is. Did you mean
           'libs/analyzers.md#anmth_octave_analyzer'?
INFO    -  Doc file 'standardFunctions.md' contains an unrecognized relative link '../libs/basics/#babeat', it was left as is. Did you mean
...

because a bunch of links would have to be "manually" fixed right ?

Yoann-Le-Borgne commented 5 days ago

Yes, mkdocs has some kind of linting on links and tries to guess the correct one if anything seems wrong. I'll close this PR and send you a new one for mkdocs 1.5.3 and with correct links that I was working on before seeing your comment.