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.32.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.32.1-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.32.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.32.1.tar.gz
Algorithm Hash digest
SHA256 67bad86ef11904d5dcb56e847c2041ed30068884145e1366e7a848d8622a452c
MD5 489488523c0b0a0b41cb9910861a1df0
BLAKE2b-256 9f3241e0ff55011ac377d6c8764408dd14f30d5be83559ee7b86ebcdbf23d7c5

See more details on using hashes here.

File details

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

File metadata

  • Download URL: mkdocs_partial-1.32.1-py3-none-any.whl
  • Upload date:
  • Size: 31.4 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.32.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d0cc955762108debe3c6588fd3cf11232cc3f3808e15619109b640e99c258acc
MD5 96304220ad74ac8af8ad61fe9dd0924c
BLAKE2b-256 5ae5c687be8d7a20c22f4c522936e524ab27858cc1afc4e22f8a29fd20ca7766

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