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.18.1.tar.gz (23.1 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.18.1-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.18.1.tar.gz
  • Upload date:
  • Size: 23.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.18.1.tar.gz
Algorithm Hash digest
SHA256 4ebcbd1f4048d3047c5bb11ae554786a9cf23ef248496743fc47a1d5b8ce3e83
MD5 57b178a25e6f7e51e6f2efaa9817293f
BLAKE2b-256 10715c97cbb8a508924e9a41eaedf15b9b55b68410270ccc80341bdde263dd00

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.18.1-py3-none-any.whl
  • Upload date:
  • Size: 31.0 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.18.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f077edf0a3cf3511b702d9d75eb0d353b17762fdca03f86cff2a106734673250
MD5 e400d6f8dc5cd4e5a4fa4a4680a3f514
BLAKE2b-256 97a35cbbb80c96b3d1746cb1b59140b77281f02476d72ea1bb66a0f942c39673

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