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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.8.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.8.1.tar.gz
Algorithm Hash digest
SHA256 4285a83cbcf8206c938c86f3e1a6aba1c20a178355f1576fbeb0486055913e57
MD5 e404760fd498aa200348c5b3a6340627
BLAKE2b-256 612bffe02d9fc5267a985075fb191e4eaf9625eba9a1ea001d8b6853aa5c3cea

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ef4d91345e32e195c74772cc7e3f1a6b3519507b8cd7b15a8cbffce3e22fb73a
MD5 39f36632eaad32d66721dca3add7b4fc
BLAKE2b-256 da9bf1509fb5592fc39ffc85cdba9d527ef46938eab98da8f45484509ba14ee1

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