Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build instructions given in the README seem incorrect #213

Closed
ShyamsundarR opened this issue Feb 24, 2017 · 1 comment
Closed

Build instructions given in the README seem incorrect #213

ShyamsundarR opened this issue Feb 24, 2017 · 1 comment

Comments

@ShyamsundarR
Copy link
Contributor

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!

Tool and platform versions that I use to build,

$ cat /etc/fedora-release 
Fedora release 24 (Twenty Four)
$ mkdocs --version
mkdocs, version 0.16.1
$ pip --version
pip 8.0.2 from /usr/lib/python2.7/site-packages (python 2.7)

I overcame this problem by,

$ 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.

@ShyamsundarR ShyamsundarR changed the title Buildl instructions given in the README seem incorrect Build instructions given in the README seem incorrect Mar 30, 2017
@ShyamsundarR
Copy link
Contributor Author

Addresses my problem. Thanks, closing this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant