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.29.1.tar.gz (23.4 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.29.1-py3-none-any.whl (31.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.29.1.tar.gz
  • Upload date:
  • Size: 23.4 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.29.1.tar.gz
Algorithm Hash digest
SHA256 387d1910f2be6dbe785e52004cca90831620581ebd4c780b9913c8256d59522d
MD5 0f5e2381027df33cc8c1a4397e751e29
BLAKE2b-256 d5fb93ef760309f77b9e440ed3026b0776ea40b738aa372d23263c3a8165108c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.29.1-py3-none-any.whl
  • Upload date:
  • Size: 31.3 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.29.1-py3-none-any.whl
Algorithm Hash digest
SHA256 929d19ec628bc29c7af97d3b39e8a1cff10a6a311e7e365c3cc3e8283c31f052
MD5 974e41535836fd697f93ee641da4b618
BLAKE2b-256 4f881faa8ac82956e4ea083cf28f6b0a315f86ba96d93f33406e999de6a5f862

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