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.19.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.19.1-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.19.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.19.1.tar.gz
Algorithm Hash digest
SHA256 48f7c4c9cc36b55fbc337449fe43d01f4734dfd5106784ba2a876b07e4d3e8d3
MD5 de2a8387a09c64ea4445605b001412d0
BLAKE2b-256 0a122609e906aab30da43a9c2b6a08e2fa6e9ce788711bdfdd19cb7db25fcd7a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.19.1-py3-none-any.whl
Algorithm Hash digest
SHA256 eb013dc6400c78414ea1f9b75db18279015123dadd74420f13d617cc0debe0a0
MD5 44e2a792ecd02a86e6c6b5347d43896c
BLAKE2b-256 ab268ad587d407b9d5a190d12aad44fadf486e4bf7ddb33d912ae1cf76dcbf2e

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