| Name | mkdocs-partial JSON |
| Version |
1.12.1
JSON |
| download |
| home_page | None |
| Summary | Mkdocs Partial Documentation |
| upload_time | 2024-11-25 21:02:50 |
| maintainer | None |
| docs_url | None |
| author | Exorids |
| requires_python | >=3.12 |
| license | None |
| keywords |
mkdocs
partial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
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 <https://docs.exordis.com/Partial%20Documentation/>`_
Raw data
{
"_id": null,
"home_page": null,
"name": "mkdocs-partial",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.12",
"maintainer_email": null,
"keywords": "mkdocs, partial",
"author": "Exorids",
"author_email": "public@exordis.com",
"download_url": "https://files.pythonhosted.org/packages/c8/b6/e4803183a4283645924e693a59890df799f37e49de76b66da198dfe03c48/mkdocs_partial-1.12.1.tar.gz",
"platform": null,
"description": "Partial documentation mkdocs plugin and tools\n\nUsage Scenarios:\n\n- **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.\n- **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.\n- **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.\n- **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.\n\n`Documentation <https://docs.exordis.com/Partial%20Documentation/>`_\n",
"bugtrack_url": null,
"license": null,
"summary": "Mkdocs Partial Documentation",
"version": "1.12.1",
"project_urls": {
"Documentation": "https://docs.exordis.com/Partial%20Documentation/",
"Homepage": "https://github.com/exordis/mkdocs-partial"
},
"split_keywords": [
"mkdocs",
" partial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e5c0181d510f418d0c5348b966700137dc5cf76df0bfdc00f1911e84661b290f",
"md5": "11ee0c6526d0a9854053e897aa64c5df",
"sha256": "9a620c95be95a2e8e180107b118324515dff84a0fafe48b6ade99c56399db63f"
},
"downloads": -1,
"filename": "mkdocs_partial-1.12.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "11ee0c6526d0a9854053e897aa64c5df",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.12",
"size": 30433,
"upload_time": "2024-11-25T21:02:49",
"upload_time_iso_8601": "2024-11-25T21:02:49.035937Z",
"url": "https://files.pythonhosted.org/packages/e5/c0/181d510f418d0c5348b966700137dc5cf76df0bfdc00f1911e84661b290f/mkdocs_partial-1.12.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c8b6e4803183a4283645924e693a59890df799f37e49de76b66da198dfe03c48",
"md5": "d5efd6ab49b4c95f72268a871c2d1bcc",
"sha256": "d84fccfd2697036fba715ee2ec0fd247e133c45145f3c18f7361d4edcb49961e"
},
"downloads": -1,
"filename": "mkdocs_partial-1.12.1.tar.gz",
"has_sig": false,
"md5_digest": "d5efd6ab49b4c95f72268a871c2d1bcc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.12",
"size": 22306,
"upload_time": "2024-11-25T21:02:50",
"upload_time_iso_8601": "2024-11-25T21:02:50.243159Z",
"url": "https://files.pythonhosted.org/packages/c8/b6/e4803183a4283645924e693a59890df799f37e49de76b66da198dfe03c48/mkdocs_partial-1.12.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-25 21:02:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "exordis",
"github_project": "mkdocs-partial",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mkdocs-partial"
}
