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.34.2.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.34.2-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for mkdocs_partial-1.34.2.tar.gz
Algorithm Hash digest
SHA256 b1abca64a829c79e12d8b2e0c9bf16bd0e3a19dae8702366edab6d7c40152f7e
MD5 f55375f7aadb986ae698368f6c9aecd0
BLAKE2b-256 03c83742e9d4a7ab307cdc912fe2a7cb0fafd87d47b3f72035fb18739fbfe194

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.34.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2b61d6c812d01c383fd8a213bafeef0832d4b50ab6c1ef41690e3581d7ff430a
MD5 98290eed356736455ec34d953e9a9b32
BLAKE2b-256 cc0955031a69b473b951abfc83f407e3ee1e83fa7c85ad1775963b1616d4b33c

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