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

Uploaded Source

Built Distribution

mkdocs_partial-1.11.1-py3-none-any.whl (30.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.11.1.tar.gz
  • Upload date:
  • Size: 22.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.11.1.tar.gz
Algorithm Hash digest
SHA256 61171360165e582016ced175aebadddd6144340812d852fbb86f63e1a046f5a6
MD5 5d830d5edf930ac26c9c796d9dc9a042
BLAKE2b-256 0e7ba04e3d6be46a4be5df555fc5b029aac6cf2489bdce59eb3bd081372fe6b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.11.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9c1545681ef08060a7bd7b1c7e8837530993021a3d36d61fa23bd8d31ffd3343
MD5 66166751a3eb50aa6dbe465dfff9beae
BLAKE2b-256 8fb46f346ab008dd40e29503a69fff7e76bd7b17d8be15f6a9cc20975fcab77e

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