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](https://www.mkdocs.org/) 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](https://docs.exordis.com/Partial%20Documentation/)

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.6.1.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

mkdocs_partial-1.6.1-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mkdocs_partial-1.6.1.tar.gz
  • Upload date:
  • Size: 22.2 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.6.1.tar.gz
Algorithm Hash digest
SHA256 102a17c7ede63e854e2baac73673a18327db2405d27c2802006fcfb428937756
MD5 d8a5e80f1612ebca19f78ce475a279c7
BLAKE2b-256 0bd64c06c4b393fdd98d94858f7cd2425cb48820550a1ea3bf0ab481a20d039d

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for mkdocs_partial-1.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e24ba539cbb98001932c99da0fa0cd100b561656a736fea0fef092810171c2f2
MD5 4e201038dcdfab975f12f1cf92e03068
BLAKE2b-256 aac018feb7e12977b7c19b6dd20a090f6ba1eff394fc1fd4220640eecc90c06e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page