The docs for an external repo are supposed to be included in the main menu directly without a docs sub menu entry. To achieve this, the contents of the docs folder inside a repository is moved up directly to the folder of the repo checkout.

This feature was broken as the code tried to insert the AccessToken for git into the first argument, even though in this case the first argument is a folder name, not a git URL. This led to the the move failing (silently).

Hi, I'd like to thank you for making this awesome plugin, first and foremost! ♥

Bug Description

Every configuration I tried leads to a FileNotFoundError: [Errno 2] No such file or directory: exception. I can't figure out whether it's my fault or a real bug in the plugin.

Let's assume we have the following, "main" doc site we're trying to build/serve:

site_name: My Docs
nav:
  - Home: 'index.md'
  - Foo: '!import {url}?branch=docs/mkdocs-bringup'
plugins:
  - multirepo

Note: I've intentionally hid the URL, but it's an enterprise Gitlab, if that's of any help. The real name of the project, currently represented as Foo, is also hidden.

Foo contains a valid mkdocs.yml, with Nav properly defined.

Now, when calling mkdocs build or mkdocs serve, I get this: FileNotFoundError: [Errno 2] No such file or directory: PosixPath('/home/timorg/my-docs/temp_dir/Foo')
I also get this when moving the import from the Nav section to the plugin's config, i.e. listing sections.

Logs

Here's what I got when running mkdocs build --verbose:

DEBUG    -  Loading configuration file: /home/timorg/service-development-docs/mkdocs.yml
DEBUG    -  Loaded theme configuration for 'mkdocs' from '/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs/themes/mkdocs/mkdocs_theme.yml': {'static_templates': ['404.html'], 'locale':
            'en', 'include_search_page': False, 'search_index_only': False, 'highlightjs': True, 'hljs_languages': [], 'hljs_style': 'github', 'navigation_depth': 2, 'nav_style': 'primary', 'analytics':
            {'gtag': None}, 'shortcuts': {'help': 191, 'next': 78, 'previous': 80, 'search': 83}}
DEBUG    -  Config value: 'config_file_path' = '/home/timorg/my-docs/mkdocs.yml'
DEBUG    -  Config value: 'site_name' = 'Service Development Docs'
DEBUG    -  Config value: 'nav' = [{'Home': 'index.md'}, {'Datastore': '!import {url}?branch=docs/mkdocs-bringup'}]
DEBUG    -  Config value: 'pages' = None
DEBUG    -  Config value: 'site_url' = ''
DEBUG    -  Config value: 'site_description' = None
DEBUG    -  Config value: 'site_author' = None
DEBUG    -  Config value: 'theme' = Theme(name='mkdocs', dirs=['/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs/themes/mkdocs',
            '/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs/templates'], static_templates=['404.html', 'sitemap.xml'], locale=Locale(language='en', territory=''),
            include_search_page=False, search_index_only=False, highlightjs=True, hljs_languages=[], hljs_style='github', navigation_depth=2, nav_style='primary', analytics={'gtag': None}, shortcuts={'help':
            191, 'next': 78, 'previous': 80, 'search': 83})
DEBUG    -  Config value: 'docs_dir' = '/home/timorg/service-development-docs/docs'
DEBUG    -  Config value: 'site_dir' = '/home/timorg/service-development-docs/site'
DEBUG    -  Config value: 'copyright' = None
DEBUG    -  Config value: 'google_analytics' = None
DEBUG    -  Config value: 'dev_addr' = Address(host='127.0.0.1', port=8000)
DEBUG    -  Config value: 'use_directory_urls' = True
DEBUG    -  Config value: 'repo_url' = ''
DEBUG    -  Config value: 'repo_name' = ''
DEBUG    -  Config value: 'edit_uri' = ''
DEBUG    -  Config value: 'extra_css' = []
DEBUG    -  Config value: 'extra_javascript' = []
DEBUG    -  Config value: 'extra_templates' = []
DEBUG    -  Config value: 'markdown_extensions' = ['toc', 'tables', 'fenced_code']
DEBUG    -  Config value: 'mdx_configs' = {}
DEBUG    -  Config value: 'strict' = False
DEBUG    -  Config value: 'remote_branch' = 'gh-pages'
DEBUG    -  Config value: 'remote_name' = 'origin'
DEBUG    -  Config value: 'extra' = {}
DEBUG    -  Config value: 'plugins' = PluginCollection([('multirepo', <mkdocs_multirepo_plugin.plugin.MultirepoPlugin object at 0x7f3746f10a90>)])
DEBUG    -  Config value: 'watch' = None
INFO     -  Multirepo plugin importing docs...
                    :   0%|                                                                                                                                                                | 0/1 [00:00<?, ?it/s]Traceback (most recent call last):
  File "/home/timorg/.local/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/click/core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs/__main__.py", line 192, in build_command
    build.build(config.load_config(**kwargs), dirty=not clean)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs/commands/build.py", line 257, in build
    config = config['plugins'].run_event('config', config)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs/plugins.py", line 102, in run_event
    result = method(item, **kwargs)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs_multirepo_plugin/plugin.py", line 150, in on_config
    return self.handle_nav_based_import(config)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs_multirepo_plugin/plugin.py", line 103, in handle_nav_based_import
    asyncio_run(batch_import(repos))
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs_multirepo_plugin/util.py", line 115, in asyncio_run
    asyncio.run(futures)
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/base_events.py", line 647, in run_until_complete
    return future.result()
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs_multirepo_plugin/structure.py", line 255, in batch_import
    repo = await import_async
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/tasks.py", line 611, in _wait_for_one
    return f.result()  # May raise f.exception().
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs_multirepo_plugin/structure.py", line 237, in import_docs
    await execute_bash_script("mv_docs_up.sh", [self.docs_dir.replace("/*", "")], cwd=self.location)
  File "/home/timorg/.local/pipx/venvs/mkdocs/lib/python3.9/site-packages/mkdocs_multirepo_plugin/util.py", line 97, in execute_bash_script
    process = await asyncio.create_subprocess_exec(
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/subprocess.py", line 236, in create_subprocess_exec
    transport, protocol = await loop.subprocess_exec(
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/base_events.py", line 1676, in subprocess_exec
    transport = await self._make_subprocess_transport(
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/unix_events.py", line 197, in _make_subprocess_transport
    transp = _UnixSubprocessTransport(self, protocol, args, shell,
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/base_subprocess.py", line 36, in __init__
    self._start(args=args, shell=shell, stdin=stdin, stdout=stdout,
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/asyncio/unix_events.py", line 789, in _start
    self._proc = subprocess.Popen(
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/subprocess.py", line 951, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "/home/timorg/.pyenv/versions/3.9.12/lib/python3.9/subprocess.py", line 1821, in _execute_child
    raise child_exception_type(errno_num, err_msg, err_filename)
FileNotFoundError: [Errno 2] No such file or directory: PosixPath('/home/timorg/my-docs/temp_dir/Foo')
                    :   0%|

Note that I've yet again replaced namings in the log to match those defined above. Sorry but it's company-internal info.

Environment

OS: Linux (WSL on top of Windows 10) Distro: Ubuntu 20.04 Python: 3.9.12 (Built with pyenv)

When i run mkdocs serve I get the following output.

INFO     -  Building documentation...
WARNING  -  Multirepo plugin is ignoring plugins.multirepo.repos. Nav takes precedence
INFO     -  Multirepo plugin importing docs...
INFO     -  Cleaning site directory
INFO     -  Multirepo plugin is cleaning up temp_dir/
INFO     -  Documentation built in 0.23 seconds
INFO     -  [16:55:53] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO     -  [16:55:53] Serving on http://127.0.0.1:8000/
WARNING  -  [16:55:54] "GET /quix-apis/ HTTP/1.1" code 404
INFO     -  [16:56:07] Browser connected: http://localhost:8000/

This is my yaml file.. I mostly copied the bits from your readme.

site_name: My Docs
 
nav:
  - Home: 'index.md'
  
plugins:
  - search
  - multirepo:
      # (optional) tells multirepo to cleanup the temporary directory after site is built.
      cleanup: true
      repos:
        - section: Backstage
          # you can define the edit uri path
          import_url: 'https://github.com/backstage/backstage?edit_uri=/blob/master/'
        - section: Monorepo
          import_url: 'https://github.com/backstage/mkdocs-monorepo-plugin?edit_uri=/blob/master/'
        - section: 'Techdocs-cli'
          # note that the branch is still specified in the url
          import_url: 'https://github.com/backstage/techdocs-cli?branch=main&edit_uri=/blob/main/'
        - section: FastAPI
          import_url: 'https://github.com/tiangolo/fastapi?docs_dir=docs/en/docs/*'
        - section: Monorepo Multi Docs
          import_url: https://github.com/backstage/mkdocs-monorepo-plugin?multi_docs=True&docs_dir=sample-docs/*
        - section: 'Django REST'
          section_path: python # Put this under the python menu entry
          import_url: 'https://github.com/encode/django-rest-framework'
        - section: 'Cookiecutter Pypackage'
          section_path: python # Put this under the python menu entry
          import_url: 'https://github.com/zillionare/cookiecutter-pypackage'
        - section: 'Pydantic'
          section_path: python # Put this under the python menu entry
          import_url: 'https://github.com/samuelcolvin/pydantic?branch=main'

I wasn't sure from the docs whether I needed the nav section as well as the plugins config. But without the nav section it fails to build. I noticed WITH the nav section that the output is saying Nav take precedence.

Hello,

To an end user of this plugin, it is not clear if the plugin even builds the documentation in the other repositories that it references. It seems to me that the plugin does the following: 1)Reference already built documentation in other repositories and make use of them in this parent repository.

The plugin does not really build the documentation (i.e run mkdocs build ) in each of the other repositories that the main repository references. This should be made crystal clear so that end users know what the plugin is capable of.

The current wording in the documentation is ambiguous and is not clear.`

Thanks, Kiran Hegde

needed this for my own personal use - hopefully it will seem like a logical feature to you.

i ran the tests in my fork and everything was passing, excluding the publish (since i dont have the pypi secret)

@jdoiro3

Thanks for the plugin. I am trying to set it up with the following parent mkdocs.yml:

site_name: Documentation

use_directory_urls: false # Either true or false results in the same issue

plugins:
  - search
  - multirepo

nav:
  - Main: index.md
  - DemoRepo: '!import https://github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main'

This builds/serves fine and I can see a temporary folder being created where demo repo is cloned. However, when I try to navigate to the "DemoRepo" menu item I get a 404 page because the link is:

http://127.0.0.1:8000/!import%20https:/github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main

I also see a warning:

WARNING - [15:35:39] "GET /!import%20https:/github.com/jdoiro3/mkdocs-multirepo-demoRepo1?branch=main HTTP/1.1" code 404

The python version I am using is 3.9.10 on Windows and the following mkdocs versions:

mkdocs                     1.2.3
mkdocs-material            8.1.8
mkdocs-material-extensions 1.0.3
mkdocs-multirepo-plugin    0.2.6

Do you have any idea what might cause this issue?

We are using a GitHub App to create an access token rather than using a personal access token (PAT). Using this token with the environment variable AccessToken yields the git error message fatal: could not read Username for 'https://github.com/': No such device or address.

This PR introduces a new GithubAccessToken environment variable, which is used in the git URL as https://x-access-token:[email protected]/.... without setting the extraheader authorization header (GitHub docs). This approach works with a PAT and an access token from a GitHub app (I tested the former locally from inside a docker container to prevent config leaking).

The functionality for the existing AccessToken environment variable stays as it is, as it might be different for other environments/git servers.

• This addresses the issues #13 and initial description of #33.
• This replaces #54 as the access token is now inserted into the URL inside the bash script and not in util.execute_bash_script which is also used for moving the docs folder.

GitHub Actions recently updated their virtual environments (see ubuntu-latest for example) and now git cli version is 2.37. This is causing problems with git sparse-checkout set used in sparse_clone.sh script because it doesn't admit patterns to be passed.

Looking at the git docs for a version that works and the one that doesn't seems that we we need to pass --no-cone flag in order to keep using patterns in the sparse checkout. I tested locally modifying the script in my local virtual environment and works but I'm not sure if it's the "real" fix, not very familiar with sparse checkouts.

while trying out the plugin, I enabled it after the installation with:

plugins:
  - multirepo

After that I wanted to start the builtin development server with mkdocs serve. But while doing so I get the following error:

Error Message

INFO     -  Building documentation...
INFO     -  Multirepo plugin importing docs...
Traceback (most recent call last):
  File "/home/vscode/.local/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
  File "/home/vscode/.local/lib/python3.10/site-packages/click/core.py", line 1128, in __call__
    return self.main(*args, **kwargs)
  File "/home/vscode/.local/lib/python3.10/site-packages/click/core.py", line 1053, in main
    rv = self.invoke(ctx)
  File "/home/vscode/.local/lib/python3.10/site-packages/click/core.py", line 1659, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/vscode/.local/lib/python3.10/site-packages/click/core.py", line 1395, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/vscode/.local/lib/python3.10/site-packages/click/core.py", line 754, in invoke
    return __callback(*args, **kwargs)
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs/__main__.py", line 177, in serve_command
    serve.serve(dev_addr=dev_addr, livereload=livereload, **kwargs)
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs/commands/serve.py", line 54, in serve
    config = builder()
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs/commands/serve.py", line 49, in builder
    build(config, live_server=live_server, dirty=dirty)
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs/commands/build.py", line 257, in build
    config = config['plugins'].run_event('config', config)
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs/plugins.py", line 102, in run_event
    result = method(item, **kwargs)
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs_multirepo_plugin/plugin.py", line 165, in on_config
    return self.handle_nav_based_import(config)
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs_multirepo_plugin/plugin.py", line 117, in handle_nav_based_import
    asyncio_run(batch_import(docs_repo_objs))
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs_multirepo_plugin/util.py", line 117, in asyncio_run
    asyncio.run(futures)
  File "/usr/local/lib/python3.10/asyncio/runners.py", line 44, in run
    return loop.run_until_complete(main)
  File "/usr/local/lib/python3.10/asyncio/base_events.py", line 641, in run_until_complete
    return future.result()
  File "/home/vscode/.local/lib/python3.10/site-packages/mkdocs_multirepo_plugin/structure.py", line 185, in batch_import
    longest_desc = max([len(f"✅ Got {repo.name} Docs") for repo in repos])
ValueError: max() arg is an empty sequence
The terminal process "/usr/bin/zsh '-c', 'mkdocs serve'" terminated with exit code: 1.

Am I missing something?

I am creating a 'documentation' repo in github which hosts a stub mkdocs.yml file under which mkdocs-multirepo-plugin should build documentation from other repos. The .yml is:

site_name: MyOrg Docs
theme: readthedocs
plugins:
  - multirepo
  - search

nav:
  - Home: 'index.md'
  - Included Services:
    - Service1: '!import https://github.com/myOrg/myRepo1?docs_dir=mydocs/*?multi_docs=True?config=mydocs/mkdocs.yml'
    - Service2: '!import https://github.com/myOrg/myRepo2?docs_dir=mydocs/*?multi_docs=True?config=mydocs/mkdocs.yml'

When I run mkdocs buildfrom my machine, it works.

I want to trigger the build of docs from a github action. Per the documentation, I added github personal access token (PAT) to the repo secrets and included that in my workflow. The workflow .yml is:

name: Build and Publish Docs 


on:
  push:
    branches: ['develop']

env:
  AWS_DEFAULT_REGION: ${{ secrets.AWS_REGION }}
  AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
  AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}

jobs:

  build_and_publish:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Install Python
        uses: actions/setup-python@v3
        with:
          python-version: 3.8

      - name: Install pip requirements
        run: |
          python -m pip install --upgrade pip
          pip install -r requirements.txt

      - name: Run mkdocs
        run: mkdocs build
        working-directory: docs-root
        env:
          AccessToken: ${{ secrets.MY_PAT }}

      #- name: Publish to S3

The output of the 'Run mkdocs' step is:

Run mkdocs build
  mkdocs build
  shell: /usr/bin/bash -e {0}
  env:
    AWS_DEFAULT_REGION: 
    AWS_SECRET_ACCESS_KEY: 
    AWS_ACCESS_KEY_ID: 
    pythonLocation: /opt/hostedtoolcache/Python/3.8.1[2](https://github.com/BuddyTV/papyrus/runs/6177823965?check_suite_focus=true#step:5:2)/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/[3](https://github.com/BuddyTV/papyrus/runs/6177823965?check_suite_focus=true#step:5:3).8.12/x6[4](https://github.com/BuddyTV/papyrus/runs/6177823965?check_suite_focus=true#step:5:4)/lib
    AccessToken: ***
INFO     -  Multirepo plugin importing docs...

                      :   0%|          | 0/2 [00:00<?, ?it/s]Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.8.12/x64/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
  File "/opt/hostedtoolcache/Python/3.8.12/x64/lib/python3.8/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
  
<<snip>>

    stdout = await execute_bash_script("sparse_clone.sh", args, self.temp_dir)
  File "/opt/hostedtoolcache/Python/3.8.12/x64/lib/python3.8/site-packages/mkdocs_multirepo_plugin/util.py", line 109, in execute_bash_script
    raise GitException(f"\n{stderr}\n")
mkdocs_multirepo_plugin.util.GitException: 
Cloning into 'PIN Service'...
fatal: could not read Username for 'https://github.com': No such device or address


Exception ignored in: <function BaseSubprocessTransport.__del__ at 0x7fe74cd8e280>
Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.8.12/x64/lib/python3.8/asyncio/base_subprocess.py", line 1[26](https://github.com/BuddyTV/papyrus/runs/6177823965?check_suite_focus=true#step:5:26), in __del__
    self.close()
  File "/opt/hostedtoolcache/Python/3.8.12/x64/lib/python3.8/asyncio/base_subprocess.py", line 104, in close
    proto.pipe.close()
  
<<snip>>

  File "/opt/hostedtoolcache/Python/3.8.12/x64/lib/python3.8/asyncio/base_events.py", line [50](https://github.com/BuddyTV/papyrus/runs/6177823965?check_suite_focus=true#step:5:50)8, in _check_closed
Error:     raise RuntimeError('Event loop is closed')
RuntimeError: Event loop is closed

                      :   0%|          | 0/2 [00:00<?, ?it/s]
Error: Process completed with exit code 1.

What am I doing wrong?

I think it doesn't work for self-hosted github enterprise. The URL here is git..com (only vpn accessible), and when running mkdocs serve:

INFO     -  Multirepo plugin is importing docs for section Section 1
[Errno 2] No such file or directory: 'where'

This is an example of the mkdocs.yml:

# Project information
site_name: Platform Wiki
site_description: Centralized location for all documentation
site_author: Platform

# Repository
repo_name: platform/centralized-docs
repo_url: https://git.<company>.com/platform/centralized-docs

nav:
  - Home: index.md
  - Login Server: '!import https://git.<company>.com/<org>/<repo>@master'

# Configuration
theme:
  name: material
  palette:
    primary: indigo
    accent: pink
    scheme: default

plugins:
  - multirepo:
      # (optional) tells multirepo to cleanup the temporary directory after site is built.
      cleanup: true
      # (optional) tells multirepo what the temp directory should be called
      temp_dir: multirepo_docs

I'm getting this when trying to build.

The process cannot access the file because it is being used by another process

I have deleted the temp_dir and still get the same. Has anyone found a work around and is there a build flag or argument to change the temp directory?

git init does not necessarily create .git/info, might be version-dependent.

Fixes #58 (but does not address the general error checking issue of this script, i.e. failing intermediate commands will still get "swallowed").

git init might not produce a .git/info dir:

$ mkdir myrepo
$ cd myrepo/
$ git init
Initialized empty Git repository in /tmp/myrepo/.git/
$ ls -l .git/
total 8
-rw-r--r--. 1 holger intern 92 Oct  6 16:19 config
-rw-r--r--. 1 holger intern 23 Oct  6 16:19 HEAD
drwxr-xr-x. 2 holger intern 27 Oct  6 16:19 hooks/
drwxr-xr-x. 4 holger intern 30 Oct  6 16:19 objects/
drwxr-xr-x. 4 holger intern 31 Oct  6 16:19 refs/
$ git --version
git version 2.24.1

Should probably add an mkdir line:

...
git remote add -f origin "$url"                     
mkdir -p .git/info  # this directory might not exist                           
for dir in "${dirs[@]}"
...

Note that you won't really notice this currently since the shell script will simply continue for the failing commands. This could be mitigated by using set -e errexit or (better) explicit error checking.

Best, Holger

Hi,

nice plugin!

Suppose you have a repo myrepowith toplevel LICENSE and AUTHORS documents that are symlinked from the docs folder, to avoid duplication but use this info in the mkdocs-generated documentation:

AUTHORS.md
LICENSE.md
docs
├── about
│   ├── AUTHORS.md -> ../../AUTHORS.md
│   └── LICENSE.md -> ../../LICENSE.md
├── index.md
mkdocs.yml

This works with mkdocs serve|build when the repo is used "standalone".

However, if you want such a repo to be imported with multirepo-plugin:

# mkdocs.yml of the importing repo
nav:
  - Home: index.md
  - Documentation:
    - myrepo: '!import https://vcs.example.org/user/myrepo?branch=feature/great-improvements&docs_dir=docs&multi_docs=False&config=mkdocs.yml&extra_imports=["AUTHORS.md", "LICENSE.md"]'

... the symlinks get broken in the temp_dir sparse checkout:

$ tree temp_dir/
temp_dir/
└── documentation
    └── myrepo
        ├── about
        │   ├── AUTHORS.md -> ../../AUTHORS.md
        │   └── LICENSE.md -> ../../LICENSE.md
        ├── AUTHORS.md
        ├── index.md
        ├── LICENSE.md
        ├── mkdocs.yml

This is due to the way the docs folders contents are put into temp_dir/documentation/myrepo directly, which changes the nesting level. This makes the symlinks invalid.

Making the links the other way round (e.g. `AUTHORS.md --> docs/about/AUTHORS.md) isn't attractive since you lose the ability to directly render the markdown files in the VCS-GUI (at least in bitbucket, in my case), since the actual git repository content of such symlinks is the path to the symlinked file.

And you also can't just reference a markdown file in nav: ...outside of the docs_dir.

Workaround: Duplicate files. Avoid links crossing docs_dir.

Best regards, Holger

Does the plugin support importing code snippets from other paths ?

We have often things like this in our doc:

--8<-- "../component/src/test/java/mkdocs/Example.java"

When building a multirepo mkdocs site, it fails:

ERROR    -  Error reading page 'example/index.md': Snippet at path
            ../component/src/test/java/mkdocs/Example.java could not be found

I am using nav based multirepo import like this:

Example: '!import [email protected]:myrepo.git?extra_imports=["component/*"]'

The imported repo structure is this:

component
  src
    test
      java
mkdocs
  mkdocs.yml