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.14.1.tar.gz (22.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.14.1-py3-none-any.whl (30.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.14.1.tar.gz
  • Upload date:
  • Size: 22.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.14.1.tar.gz
Algorithm Hash digest
SHA256 56d684204d21ce7a866881522cec23416f83521400c068d15da23d021b6eef80
MD5 d044d0a46926fed9836c936a930a80b0
BLAKE2b-256 71580b67fb0857c48cbcd61e072a5e34830f0ddb0b983e7f22fbb421fe5e8744

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.14.1-py3-none-any.whl
  • Upload date:
  • Size: 30.5 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.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cdba7c52b4e2bc481a16b25886a9d273a44c797572644dae91ce636d340b5d97
MD5 1997205aa4a6b689fec3c7bc71ad5486
BLAKE2b-256 3247c00d72759dc702b763ba4a41b9c07498fca59d609f6e289560f0abc1ac81

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