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.10.1.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

mkdocs_partial-1.10.1-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.10.1.tar.gz
  • Upload date:
  • Size: 22.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.10.1.tar.gz
Algorithm Hash digest
SHA256 c7d0a5a0fc9cfe857cc795ca4ad20b8477a04955db57c28b3e575a0f05acaae7
MD5 f4ea7956eab68857207f0a77091f0e35
BLAKE2b-256 97e1f2512a1c48d99a6cc8f98fc9378ffe818fae502ba3510438a92673e7fdd0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 60bb66784f76e4db707d2ad499820bf22dc42159c6bd29071c5b5d816e0deaaf
MD5 bc550880da1ca849c46274676fad88e0
BLAKE2b-256 175a04dd69db18e5ca649765b49a2c7bbbe1e1cb7d963d00997cc7dc5d3f9720

See more details on using hashes here.

Supported by

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