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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.26.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.26.1.tar.gz
Algorithm Hash digest
SHA256 aaab9bbdde9441c4e34efdd58603edd4234a3f012644981866c21dbba78dd575
MD5 9451260bf3894c11b565cbfb8baeb702
BLAKE2b-256 6ae53c9616caf5611d0be94b2b5bf336a84f9e4dd76d61cf78f1b948e88fd089

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.26.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.26.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a943becffb1342e1fd08fb31c83853f1f7a9817c520ddf36d25a595cd1f4b5ff
MD5 6d28752da5943222d4bacac718475309
BLAKE2b-256 c87691ba61753cbb102f6540d380ac3991f6ae4a5733a3e549b3b5f547645003

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