Release v0.7.0

Changes in this Release

Prs in Release

• Fix section case
• Remove deprecation warning

Release v0.6.3

Changes in this Release

Prs in Release

• Only exclude mkdocs config YAML files.

Release v0.6.2

Changes in this Release

Prs in Release

• Fix deps for Python 3.10

Release v0.6.1

Changes in this Release

Prs in Release

• Disable globbing in clone scripts
• Fix keep docs dir

Release v0.6.0

Changes in this Release

Prs in Release

• Add support for nav repos

Added Features

A new nav_repos was added to the configuration. This is similar to the repos configuration except that nav_repos
expects a nav to be present to use in the navigation. This configuration can also be used along with !import statements.

Usage Example

See example

plugins:
  - search
  - multirepo:
      # (optional) tells multirepo to cleanup the temporary directory after site is built.
      cleanup: false
      nav_repos:
        - name: backstage
          import_url: https://github.com/backstage/backstage
          # forward slash is needed in '/README.md' so that only the README.md in the root
          # directory is imported and not all README.md files.
          imports: [
            docs/publishing.md, docs/integrations/index.md, /README.md,
            # asset files needed
            docs/assets/*
            ]
        - name: fast-api
          import_url: https://github.com/tiangolo/fastapi
          imports: [docs/en/docs/index.md]

nav:
  - Backstage:
      - Home: backstage/README.md
      - Integration: backstage/docs/integrations/index.md
      - Publishing: backstage/docs/publishing.md
  - FastAPI: fast-api/docs/en/docs/index.md
  # you can still use the !import statement
  - MkdocStrings: '!import https://github.com/mkdocstrings/mkdocstrings'

In addition this release adds keeps_docs_dir to the !import statement, which means one imported repo can override the behavior set by the global configuration. See Fix edit urls and add new keep_docs_dir config param for more details.

Release v0.5.0

Changes in this Release

PRs in Release

• Create .git/info dir if it does not exist
• Fix edit urls and add new keep_docs_dir config param
• Fix Readme

Added Features

A new keep_docs_dir was added to the multirepo config. Setting this to true will cause the plugin to not move the contents of the docs_dir up and delete it. See issue #74 for more details.

Usage Example

plugins:
  - search
  - multirepo:
      keep_docs_dir: true

Release v0.4.12

Changes in this Release

• Fixed use of GithubAccessToken environment variable so that the sparse clone now uses the correct token.

Release v0.4.11

Changes in this Release

• Added a specific GithubAccessToken environment variable that allows usage of the plugin with GitHub Apps-generated access tokens and personal access tokens.
• Fixed edit urls for imported repos where the the Mkdocs edit_uri and repo_url aren't set, and the Multirepo edit_uri for an imported repo isn't set. Note that the edit url for imported repos hasn't been robustly tested yet.

Slugify Section Names and Changed Import Param Separator

Breaking Changes

• Previously, you would separate config values in an !import statement using multiple ampersands (&). Now, the !import statement will follow general URL syntax, where the url and query string (config values) is separated by one question mark (?) and then each config section is separated by an ampersand. Below is an example !import statement.
  '!import {url}?branch={branch}&docs_dir={path}&multi_docs={True | False}&config={filename}.yml'

Other Changes

• Section names are slugified for clear urls (see PR #28 and Issue #24 for details). This most likely will change in future releases.

0.3.6

Added ability to clone git repos in github workflows with PAT authentication.