Skip to main content

Mkdocs Partial Documentation

Project description

Partial documentation mkdocs plugin and tools

Usage Scenarios:

  • Keep documentation close to the code: When a project has multiple repositories, each with its own documentation, the documentation site can be assembled from all repository docs.

  • Share a documentation subset across multiple sites: For projects that share some code but maintain independent documentation, the shared documentation part can be distributed as a package and linked to each project site.

  • Synchronize the look and feel of multiple sites: When several documentation sites need a unified look and feel, the shared site configuration and UI customizations can be distributed, even though the content differs.

  • Bypass the MkDocs requirement to keep all content in the docs_dir: If the docs_dir constraint is limiting, documentation content from outside docs_dir can be linked into the site.

Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mkdocs_partial-1.31.1.tar.gz (23.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkdocs_partial-1.31.1-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

Details for the file mkdocs_partial-1.31.1.tar.gz.

File metadata

  • Download URL: mkdocs_partial-1.31.1.tar.gz
  • Upload date:
  • Size: 23.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for mkdocs_partial-1.31.1.tar.gz
Algorithm Hash digest
SHA256 60b74455d1e26cb16df57469dfb78bf019ca83d93ab50c2067766c727581fd50
MD5 14ecbd38c6ed41ef7b3d8452b1f7002a
BLAKE2b-256 4c299b3f2ff69773762184ac7bc8038a3d430eb8cdedd0931f8170acb8e8b718

See more details on using hashes here.

File details

Details for the file mkdocs_partial-1.31.1-py3-none-any.whl.

File metadata

  • Download URL: mkdocs_partial-1.31.1-py3-none-any.whl
  • Upload date:
  • Size: 31.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.11.10

File hashes

Hashes for mkdocs_partial-1.31.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a6c43951add327dacf53f56d0e382bffa68f342680bf3a0f8f962e338a52630
MD5 81936275a0fe7ddd3cd00ea55e01a72c
BLAKE2b-256 16e01dca01f51252129b0ce49e97e95d6fed69b9dec7b97da967763cbea60f81

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page