You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The build instructions presented in the README.md at the root of this project seem incorrect.
When building using,
$ mkdocs build
from the root of the repository I get the following errors,
$ mkdocs build
WARNING - Config value: 'extra_css'. Warning: The following files have been automatically included in the documentation build and will be added to the HTML: site/css/highlight.css,site/css/theme.css,site/css/theme_extra.css. This behavior is deprecated. In version 1.0 and later they will need to be explicitly listed in the 'extra_css' config setting.
WARNING - Config value: 'extra_javascript'. Warning: The following files have been automatically included in the documentation build and will be added to the HTML: site/js/highlight.pack.js,site/js/jquery-2.1.1.min.js,site/js/modernizr-2.8.3.min.js,site/js/theme.js,site/mkdocs/js/lunr.min.js,site/mkdocs/js/mustache.min.js,site/mkdocs/js/require.js,site/mkdocs/js/search.js,site/mkdocs/js/text.js. This behavior is deprecated. In version 1.0 and later they will need to be explicitly listed in the 'extra_javascript' config setting.
ERROR - Config value: 'docs_dir'. Error: The 'docs_dir' should not be the parent directory of the config file. Use a child directory instead so that the config file is a sibling of the config file.
ERROR - Config value: 'site_dir'. Error: The 'site_dir' should not be within the 'docs_dir' as this leads to the build directory being copied into itself and duplicate nested files in the 'site_dir'.(site_dir: '.../glusterdocs/site', docs_dir: '.../glusterdocs')
Aborted with 2 Configuration Errors!
$ cp ./mkdocs.yml ../
$ cd ..
# edit "docs_dir: ./glusterdocs/" in the copied mkdocs.yml
$ mkdocs build
# site directory is now a sibling of glusterdocs directory
I am not entirely sure if what I did is right or this is the way to do it, the errors seem to point that this is how it possibly needs to be done.
So in case this is right, request that README.md be updated with the same.
The text was updated successfully, but these errors were encountered:
ShyamsundarR
changed the title
Buildl instructions given in the README seem incorrect
Build instructions given in the README seem incorrect
Mar 30, 2017
The build instructions presented in the README.md at the root of this project seem incorrect.
When building using,
from the root of the repository I get the following errors,
Tool and platform versions that I use to build,
I overcame this problem by,
I am not entirely sure if what I did is right or this is the way to do it, the errors seem to point that this is how it possibly needs to be done.
So in case this is right, request that README.md be updated with the same.
The text was updated successfully, but these errors were encountered: