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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.28.1.tar.gz
  • Upload date:
  • Size: 23.3 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.28.1.tar.gz
Algorithm Hash digest
SHA256 23697129d94af0bf05434a42892e89bdd4a8944a56883c1525ea72ecf4b792a9
MD5 fde4aeb491fc11496ea78de3030903b2
BLAKE2b-256 8e28e5eb86b04c7fbf9cc22a4c8f6268666da5ccbbc432cc036c7255fed54a0a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.28.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.28.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b5504c41a307b87fe45998f14c261b492025ea3d4a2ffceaeca208b77df85d69
MD5 0b5b98978df94aeb989943637bf703ca
BLAKE2b-256 d6b6ed13134adae5c68f074eab60b22c70d2ecedf08858a2a16ec16b8fa6e650

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