mkdocs-partial 1.4.1__tar.gz → 1.7.1__tar.gz

{mkdocs_partial-1.4.1 → mkdocs_partial-1.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-partial
-Version: 1.4.1
+Version: 1.7.1
 Summary: Mkdocs Partial Documentation
 Author: Exorids
 Project-URL: Homepage, https://github.com/exordis/mkdocs-partial
@@ -29,4 +29,13 @@ Requires-Dist: pytest-mock<4.0.0,>=3.0.0; extra == "test"
 Requires-Dist: pytest-resource-path==1.3.0; extra == "test"
 Requires-Dist: docs-documentation; extra == "test"
 
-Mkdocs Partial Documentation
+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/>`_

mkdocs_partial-1.7.1/PypiDescription.rst

@@ -0,0 +1,10 @@
+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/>`_

mkdocs_partial-1.7.1/README.md

@@ -0,0 +1,3 @@
+# Summary
+
+Partial documentation mkdocs plugin and tools

mkdocs_partial-1.7.1/mkdocs_partial/version.py

@@ -0,0 +1 @@
+__version__ = "1.7.1"

{mkdocs_partial-1.4.1 → mkdocs_partial-1.7.1}/mkdocs_partial.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocs-partial
-Version: 1.4.1
+Version: 1.7.1
 Summary: Mkdocs Partial Documentation
 Author: Exorids
 Project-URL: Homepage, https://github.com/exordis/mkdocs-partial
@@ -29,4 +29,13 @@ Requires-Dist: pytest-mock<4.0.0,>=3.0.0; extra == "test"
 Requires-Dist: pytest-resource-path==1.3.0; extra == "test"
 Requires-Dist: docs-documentation; extra == "test"
 
-Mkdocs Partial Documentation
+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/>`_

{mkdocs_partial-1.4.1 → mkdocs_partial-1.7.1}/mkdocs_partial.egg-info/SOURCES.txt

@@ -1,4 +1,5 @@
 LICENSE
+PypiDescription.rst
 README.md
 pyproject.toml
 setup.cfg

{mkdocs_partial-1.4.1 → mkdocs_partial-1.7.1}/setup.cfg

@@ -2,7 +2,7 @@
 name = mkdocs-partial
 version = attr: mkdocs_partial.version.__version__
 description = Mkdocs Partial Documentation
-long_description = Mkdocs Partial Documentation
+long_description = file: PypiDescription.rst
 author = Exorids
 keywords = mkdocs, partial
 classifiers = 

mkdocs_partial-1.4.1/README.md

@@ -1,5 +0,0 @@
-# Summary
-
-Partial documentation mkdocs plugin and tools
-
-[Documentation](https://docs.exordis.com/Partial%20Documentation/)

mkdocs_partial-1.4.1/mkdocs_partial/version.py

@@ -1 +0,0 @@
-__version__ = "1.4.1"