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.27.1.tar.gz (23.2 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.27.1-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.27.1.tar.gz
  • Upload date:
  • Size: 23.2 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.27.1.tar.gz
Algorithm Hash digest
SHA256 7e9e7fbf092e54ec133d596afb26d5bf196fa9bd3ee8086d09b503ee2a5bf70a
MD5 aaf17a2eabff131c847dcefc1f3c8142
BLAKE2b-256 3ac93355a936f3b60df2bb37fea126af5c8d87fb399346e5826e2ef16a4a8e36

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.27.1-py3-none-any.whl
  • Upload date:
  • Size: 31.2 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.27.1-py3-none-any.whl
Algorithm Hash digest
SHA256 533e20dc347b166e2dd538453caed8174c1e44837de3064d474038b6ae342c81
MD5 f1b6c6caf3ea1d9b891c91ef01228b38
BLAKE2b-256 b82da1c50bc58f546d68785ad256a0b5c84263ae8f0c0957765c1669eb763a14

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