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

allow links to be followed in copy_media_files #869

realjo opened this Issue Mar 17, 2016 · 2 comments


None yet
3 participants

realjo commented Mar 17, 2016

I want to set up a small documentation server that checks out all our projects from a local
gitlab repo and link the docs directories of each of them as sub folders of a separate docs
folder with its own file and a page for each project in the mkdoc.yml like in this example:

site_name: Our Documentation Collection
  - Home:
  - project1: project1/
  - project2: project2/  

Because project1 and project2 are logical links to the git clone's docs directories, media files
are not copied to site_dir and thus e.g. images inside the projects not visible in the generated

To fix it I propose to add ", followlinks=True" to os.walk in copy_media_files

def copy_media_files(from_dir, to_dir):
    Recursively copy all files except markdown and HTML into another directory.
    for (source_dir, dirnames, filenames) in os.walk(from_dir, followlinks=True):

This comment has been minimized.


d0ugal commented Mar 17, 2016

Hmm, interesting. I wonder if this could cause any issues. I am not sure how I feel about this change, I will give it some thought. It does seem like quite a niche request given it hasn't been raised before.


This comment has been minimized.


d0ugal commented Apr 24, 2016

I think I would be happy for this change to happen, I can't think of any problems with it and there have been no objections.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment