Registry / web-framework / mkdocs-multirepo-plugin

mkdocs-multirepo-plugin

library0.8.3pypypiunverified

MkDocs plugin to build documentation from multiple repositories into one unified site. Version 0.8.3. Release cadence: irregular, several releases per year.

web-framework devops

pip install mkdocs-multirepo-plugin

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · MKDOCS-MULTIREPO-P

mkdocs-multirepo-plugin

web-frameworkpythonv0.8.3

Install

3.3s avg

Import

—

Disk

33MB

Pass rate

10/ 10

Env Coverage10 / 10

glibc

3.9–3.13

musl

3.9–3.13

Install & Compatibility

Where this runs

tested against v0.8.3 · pip install

no network on importno background threads

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

py 3.10–3.95 runs

installs and imports cleanly · install 0.0s · import 0.000s · 34.1MB

glibc

py 3.10–3.95 runs

installs and imports cleanly · install 3.3s · import 0.000s · 35MB

33MB installed

● package 33MB

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

plugin

✓ plugins: - multirepo

✗ plugins: - mkdocs-multirepo-plugin

The plugin is registered by its short name 'multirepo', not the full package name.

Basic configuration to include documentation from an external git repository.

# mkdocs.yml site_name: My Docs plugins: - multirepo: repos: - section: Repo A url: https://github.com/example/repo-a.git branch: main

Debug

Known issues

gotchaThe plugin requires the Git executable to be installed and available in PATH. Cloning repos fails silently if git is missing.

fix

Ensure git is installed: `git --version` should succeed.

affects: all

deprecatedThe `repos` configuration parameter was deprecated in favour of `nav_repos` for navigation support. Using `repos` without a nav may yield unexpected navigation ordering.

fix

Use `nav_repos` with a `nav` key to control navigation structure.

affects: >=0.6.0

gotchaWhen using `!import` statements in mkdocs.yml, the path must be relative to the docs directory. Relative paths from project root cause import errors.

fix

Use relative paths starting from the docs directory, e.g., `!import path/to/file.md`.

affects: all

breakingIn version 0.6.0, the default behaviour changed: docs_dir contents are moved into a subdirectory. Set `keep_docs_dir: true` to preserve existing behaviour.

fix

Add `keep_docs_dir: true` to the plugin config if you want the docs_dir to remain unchanged.

affects: >=0.6.0

Upgrade

Version history

0.8.3latest on PyPI · released Aug 13, 2024

Audit

Dependencies

mkdocsrequiredRequired core dependency

Agent activity

3 hits · last 30 days

node

Bingbot

Resources

githubhttps://github.com/jdoiro3/mkdocs-multirepo-plugin ↗

packagehttps://pypi.org/project/mkdocs-multirepo-plugin/ ↗

homepagehttps://pypi.org/project/mkdocs-multirepo-plugin/ ↗