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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.9.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.9.1.tar.gz
Algorithm Hash digest
SHA256 e9d09e244ee9c3e11b73d00902efc01a17bb235c3a9c39b870473324caf0f0c6
MD5 da936f8f5b5e81fab60027de74b94241
BLAKE2b-256 fffcec4ad52bfaf2f7d099ea8ec741641b5b4f1ab2fee5ec6846a99d94eb67df

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.9.1-py3-none-any.whl
Algorithm Hash digest
SHA256 17154acb8c736cc7abfc5780d09d11f595739b0434dac92b993614c42699f8ea
MD5 5b81fd7f5cf3952b324c86596df59a7d
BLAKE2b-256 8cebe114f346c529bb4c8c608060a1d907cfe38b59e89ad90901bccd25093af3

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