Skip to content

docs_dir and site_dir errors during build #4231

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

Closed
jorisshh opened this issue Jun 13, 2018 · 2 comments
Closed

docs_dir and site_dir errors during build #4231

jorisshh opened this issue Jun 13, 2018 · 2 comments
Labels
Support Support question

Comments

@jorisshh
Copy link

jorisshh commented Jun 13, 2018

Details

Expected Result

Build fails due to errors.

My mkdocs.yml file from git repo:

site_name: Rucksack Docs
site_author: Devdog
site_url: https://devdog.io

markdown_extensions:
 - admonition

cat mkdocs.yml during build:

docs_dir: /home/docs/checkouts/readthedocs.org/user_builds/rucksack-docs/checkouts/latest
extra_css: ['https://media.readthedocs.org/css/badge_only.css', 'https://media.readthedocs.org/css/readthedocs-doc-embed.css']
extra_javascript: [readthedocs-data.js, 'https://media.readthedocs.org/static/core/js/readthedocs-doc-embed.js',
  'https://media.readthedocs.org/javascript/readthedocs-analytics.js']
google_analytics: null
markdown_extensions: [admonition]
site_author: Devdog
site_name: Rucksack Docs
site_url: https://devdog.io
theme_dir: /home/docs/checkouts/readthedocs.org/readthedocs/templates/mkdocs/readthedocs

Errors:

WARNING -  Config value: 'theme_dir'. Warning: The configuration option {0} has been deprecated and will be removed in a future release of MkDocs. 
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: '/home/docs/checkouts/readthedocs.org/user_builds/rucksack-docs/checkouts/latest/_build/html', docs_dir: '/home/docs/checkouts/readthedocs.org/user_builds/rucksack-docs/checkouts/latest') 

Aborted with 2 Configuration Errors!

Am I missing something here? My repos are unchanged and worked perfectly before.

@stsewd stsewd added the Support Support question label Jun 13, 2018
@stsewd
Copy link
Member

stsewd commented Jun 13, 2018

We upgrade the version of mkdocs, you can pin in your requirements.txt file a compatible version, or fix your project structure. Please see https://www.mkdocs.org/about/release-notes/#stricter-directory-validation

@jorisshh
Copy link
Author

Thanks. Moved everything to docs/ folder and all is working well 👍

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

No branches or pull requests

2 participants