Skip to content

allow links to be followed in copy_media_files #869

Description

@realjo

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 index.md file and a page for each project in the mkdoc.yml like in this example:

site_name: Our Documentation Collection
pages:
  - Home: index.md
  - project1: project1/index.md
  - project2: project2/index.md  

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

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):

Activity

  1. d0ugal commented on Mar 17, 2016

    @d0ugal
    Contributor

    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.

  2. d0ugal commented on Apr 24, 2016

    @d0ugal
    Contributor

    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.

  3. added a commit that references this issue on May 25, 2016
    66b00e5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions