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.25.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.25.1-py3-none-any.whl (31.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.25.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.25.1.tar.gz
Algorithm Hash digest
SHA256 7772a24dd6c93a2917bbac0293e6e1fef9ff9482b87db8244bcdc7d27f254437
MD5 ee36aa6092c59e9db5b147ea51994e58
BLAKE2b-256 e7b6a37f8a176d7179c7e54719aee01d97340e2c62f1a088589a2834ae3b4d21

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.25.1-py3-none-any.whl
  • Upload date:
  • Size: 31.1 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.25.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fe66836a6b09a3d08d16031c377647215954d5b0e6a062ac54447bf3eeda5ae1
MD5 b6fe386eadfc33f5cebe0e4cc323a77f
BLAKE2b-256 ea5cf53aaf8ca53bd345831a1e6ee9f0124e9601953a6c2b8c9739d8cbe7447a

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