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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.7.1.tar.gz
  • Upload date:
  • Size: 22.1 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.7.1.tar.gz
Algorithm Hash digest
SHA256 0a357022fe3489dc78896c34005d6b274d279eff08f038f5eac6a46c84914731
MD5 b17d29620dd540a4ba2ac958fd6df578
BLAKE2b-256 d777244e3d0f0d23763c267f59b27326515f77f15b064449d951db2191c47aaf

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b2dc45ae28fcf57770107c465050b4f48357c982245d84120caa3e1f2daf50b
MD5 969a64baa7237c85f3011e9f51980d0d
BLAKE2b-256 9a0b986a997b850fafb64daf2e6b880bd1a95a89b929f1400c709dad9dd5430f

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