Release v0.8.3

Changes in this Release

Prs in Release

• Fix script execution in virtualenvs

Release v0.8.2

Changes in this Release

Prs in Release

• Fix Version Parsing and Git Version Check

Release v0.8.1

Changes in this Release

Prs in Release

• Better Git Version Parsing and Checking

Release v0.8.0

Changes in this Release

Prs in Release

• Support edit_url starting with http
• Support Gitlab CI job token

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