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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.22.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.22.1.tar.gz
Algorithm Hash digest
SHA256 7f51d9547d78ca8f91b2a146c1097a0ad33ff35437c99a8e6b6b9835a582321c
MD5 4e1801c734921e0ec8b136969733bca1
BLAKE2b-256 7c9c158805505bfb1776763bd06f99bae5919b83616e21fa6240bcfe30aec004

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b3b01ad55e575df10122b48d383354e798eb50bfc2457602f24da24eb2dcf0b2
MD5 d262f3375d37a8a49241284ecf4f6ba8
BLAKE2b-256 0e226179e81dfdaa15684db0421cbe8987493e994ca3210d5d42cfeed79f9f33

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