drf-to-mkdoc 0.1.8__py3-none-any.whl → 0.2.0__py3-none-any.whl

drf_to_mkdoc/utils/common.py

@@ -174,39 +174,44 @@ def get_custom_schema():
 def convert_to_django_path(path: str, parameters: list[dict[str, Any]]) -> str:
     """
     Convert a path with {param} to a Django-style path with <type:param>.
-    If PATH_PARAM_SUBSTITUTOR is set, use that function instead.
+    If PATH_PARAM_SUBSTITUTE_FUNCTION is set, use that function instead.
     """
     function = None
-    func_path = getattr(drf_to_mkdoc_settings, "PATH_PARAM_SUBSTITUTOR", None)
+    func_path = drf_to_mkdoc_settings.PATH_PARAM_SUBSTITUTE_FUNCTION
 
     if func_path:
         try:
             function = import_string(func_path)
         except ImportError:
-            logger.warning("PATH_PARAM_SUBSTITUTOR is not a valid import path")
+            logger.warning("PATH_PARAM_SUBSTITUTE_FUNCTION is not a valid import path")
 
     # If custom function exists and returns a valid value, use it
+    PATH_PARAM_SUBSTITUTE_MAPPING = drf_to_mkdoc_settings.PATH_PARAM_SUBSTITUTE_MAPPING
     if callable(function):
         try:
-            value = function(path, parameters)
-            if isinstance(value, str) and value.strip():
-                return value
+            result = function(path, parameters)
+            if result and isinstance(result, dict):
+                PATH_PARAM_SUBSTITUTE_MAPPING.update(result)
         except Exception as e:
             logger.exception("Error in custom path substitutor: %s", e)
 
     # Default Django path conversion
     def replacement(match):
         param_name = match.group(1)
-        param_info = next((p for p in parameters if p.get("name") == param_name), {})
-        param_type = param_info.get("schema", {}).get("type")
-        param_format = param_info.get("schema", {}).get("format")
-
-        if param_type == "integer":
-            converter = "int"
-        elif param_type == "string" and param_format == "uuid":
-            converter = "uuid"
+        custom_param_type = PATH_PARAM_SUBSTITUTE_MAPPING.get(param_name)
+        if custom_param_type and custom_param_type in ("int", "uuid", "str"):
+            converter = custom_param_type
         else:
-            converter = "str"
+            param_info = next((p for p in parameters if p.get("name") == param_name), {})
+            param_type = param_info.get("schema", {}).get("type")
+            param_format = param_info.get("schema", {}).get("format")
+
+            if param_type == "integer":
+                converter = "int"
+            elif param_type == "string" and param_format == "uuid":
+                converter = "uuid"
+            else:
+                converter = "str"
 
         return f"<{converter}:{param_name}>"
 

drf_to_mkdoc/utils/endpoint_detail_generator.py

@@ -572,14 +572,22 @@ def _create_endpoint_header(
         "stylesheets/endpoints/animations.css",
         "stylesheets/endpoints/accessibility.css",
         "stylesheets/endpoints/loading.css",
+        "stylesheets/endpoints/try-out-sidebar.css",
+    ]
+    scripts = [
+        "javascripts/try-out-sidebar.js",
     ]
     prefix_path = f"{drf_to_mkdoc_settings.PROJECT_NAME}/"
     css_links = "\n".join(
         f'<link rel="stylesheet" href="{static(prefix_path + path)}">' for path in stylesheets
     )
+    js_scripts = "\n".join(
+        f'<script src="{static(prefix_path + path)}" defer></script>' for path in scripts
+    )
     content = f"""
-<!-- inject CSS directly -->
+<!-- inject CSS and JS directly -->
 {css_links}
+{js_scripts}
 """
     content += f"# {method.upper()} {path}\n\n"
     content += f"{format_method_badge(method)} `{path}`\n\n"

drf_to_mkdoc/utils/model_detail_generator.py

@@ -20,7 +20,7 @@ def generate_model_docs(models_data: dict[str, Any]) -> None:
         write_file(file_path, content)
 
 
-def render_fields_table(fields: dict[str, Any]) -> str:
+def render_column_fields_table(fields: dict[str, Any]) -> str:
     """Render the fields table for a model."""
     content = "## Fields\n\n"
     content += "| Field | Type | Description | Extra |\n"
@@ -31,6 +31,10 @@ def render_fields_table(fields: dict[str, Any]) -> str:
         verbose_name = field_info.get("verbose_name", field_name)
         help_text = field_info.get("help_text", "")
 
+        display_name = field_name
+        if field_type in ["ForeignKey", "OneToOneField"]:
+            display_name = f"{field_name}_id"
+
         extra_info = []
         if field_info.get("null"):
             extra_info.append("null=True")
@@ -51,7 +55,7 @@ def render_fields_table(fields: dict[str, Any]) -> str:
         extra_str = ", ".join(extra_info) if extra_info else ""
         description_str = help_text or verbose_name
 
-        content += f"| `{field_name}` | {field_type} | {description_str} | {extra_str} |\n"
+        content += f"| `{display_name}` | {field_type} | {description_str} | {extra_str} |\n"
 
     return content
 
@@ -121,35 +125,29 @@ def _create_model_header(name: str, app_label: str, table_name: str, description
 
 def _add_fields_section(model_info: dict[str, Any]) -> str:
     """Add the fields section to the model documentation."""
-    fields = model_info.get("fields", {})
-    non_relationship_fields = {
-        name: info
-        for name, info in fields.items()
-        if info.get("type", "") not in ["ForeignKey", "OneToOneField", "ManyToManyField"]
-    }
-
-    if not non_relationship_fields:
+    column_fields = model_info.get("column_fields", {})
+    if not column_fields:
         return ""
 
-    content = render_fields_table(non_relationship_fields)
-    content += "\n"
-    content += render_choices_tables(non_relationship_fields)
-    content += "\n"
+    content = ""
+
+    column_fields_content = render_column_fields_table(column_fields)
+    if column_fields_content:
+        content += column_fields_content
+        content += "\n"
+
+    choices_content = render_choices_tables(column_fields)
+    if choices_content:
+        content += choices_content
+        content += "\n"
+
     return content
 
 
 def _add_relationships_section(model_info: dict[str, Any]) -> str:
     """Add the relationships section to the model documentation."""
-    fields = model_info.get("fields", {})
-    relationships = model_info.get("relationships", {})
-
-    relationship_fields = {
-        name: info
-        for name, info in fields.items()
-        if info.get("type", "") in ["ForeignKey", "OneToOneField", "ManyToManyField"]
-    }
-
-    if not (relationships or relationship_fields):
+    relationship_fields = model_info.get("relationships", {})
+    if not relationship_fields:
         return ""
 
     content = "## Relationships\n\n"
@@ -157,7 +155,7 @@ def _add_relationships_section(model_info: dict[str, Any]) -> str:
     content += "|-------|------|---------------|\n"
 
     content += _render_relationship_fields(relationship_fields)
-    content += _render_relationships_from_section(relationships)
+    content += _render_relationships_from_section(relationship_fields)
     content += "\n"
 
     return content

{drf_to_mkdoc-0.1.8.dist-info → drf_to_mkdoc-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: drf-to-mkdoc
-Version: 0.1.8
+Version: 0.2.0
 Summary: Generate Markdown API docs from Django/DRF OpenAPI schema for MkDocs
 Author-email: Hossein Shayesteh <shayestehhs1@gmail.com>
 Maintainer-email: Hossein Shayesteh <shayestehhs1@gmail.com>

{drf_to_mkdoc-0.1.8.dist-info → drf_to_mkdoc-0.2.0.dist-info}/RECORD

@@ -1,16 +1,17 @@
 drf_to_mkdoc/__init__.py,sha256=IbTW5uKQvJRG9ncHRuk_AGKHPn4ruxs5LqDpUFgUhws,180
 drf_to_mkdoc/apps.py,sha256=-NrC_dRr6GmLmNQhkNh819B7V1SS4DYDv5JOR0TtuJM,560
 drf_to_mkdoc/conf/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-drf_to_mkdoc/conf/defaults.py,sha256=hEjQdN3WsT539UWhFkylI60piykV_7BDudLPNd_E8PE,575
+drf_to_mkdoc/conf/defaults.py,sha256=DZiATgfjkyU_J1RgR_zAzPdOVp-F2o3LVwjb3hP6j0U,660
 drf_to_mkdoc/conf/settings.py,sha256=OOna4jWNTEfROBprpKnEHVl5RcAYExmOf0gBMA0E_FY,1664
 drf_to_mkdoc/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/management/commands/build_docs.py,sha256=71dDDbb-qjRZr0kugviHtf3W_MSPFVjxkJ0tlLn97zM,4037
 drf_to_mkdoc/management/commands/generate_doc_json.py,sha256=mWdYgMbSeLP4iQZeUm2DxwYQmdGy8w05XTEfbT_nOJo,19833
-drf_to_mkdoc/management/commands/generate_docs.py,sha256=LUvKeJQ_cDL48rEfbWyjDsYEwzkQEpxpEjqUm11zQJg,5011
-drf_to_mkdoc/management/commands/generate_model_docs.py,sha256=A_Q6o10kfy-GN_ZDD9YS6jv3RTyxBy28DEsi5qKZZoU,13421
+drf_to_mkdoc/management/commands/generate_docs.py,sha256=yxCuU5gXqpHEyL-U-li-s7X1Hae86Cb-Q2z3xlonw0k,4346
+drf_to_mkdoc/management/commands/generate_model_docs.py,sha256=_A-C7gIZhCzFN4g9D8uwrd2yQW-HzgibCu4z_vx0QLM,13477
 drf_to_mkdoc/management/commands/update_doc_schema.py,sha256=TtHVQxnVpB_VELRkVcdsDXDU5zXdguFleB1mXCDMAbg,2009
 drf_to_mkdoc/static/drf-to-mkdoc/javascripts/endpoints-filter.js,sha256=KtfWroqsXg-wwmk36hpoH--M9WIW85EFNGeswMjFu4g,6138
+drf_to_mkdoc/static/drf-to-mkdoc/javascripts/try-out-sidebar.js,sha256=zvEIm5rxTdMdmzElmmAqniIrI4ms2vsqGOMI0VFb_RQ,38953
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/accessibility.css,sha256=DwCGPoaxaUvyifryrKqmkFDH06XBNf65kYsflMTbi0M,494
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/animations.css,sha256=61m9SLAbatVUNuFeTUTxktoMu9SskYcwFjTsHYbsCRo,393
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/badges.css,sha256=kUlUcf72uRw6x6Gn7cUq_aTuSGBbhumZ4Us-eBDM7DM,1251
@@ -26,6 +27,7 @@ drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/sections.css,sha256=xdrO6
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/stats.css,sha256=0cDD8s63r6zQid_O1schNvfIwys1Y526xO6-B6s4Lxc,667
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/tags.css,sha256=dOw13qsvVjx9cibzgzXlOutXVosNp6LzFfEFKvumG8w,1785
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/theme-toggle.css,sha256=j1P5xDQDfos8jeVYz5s1jjEeujMlZtLi39OC6VeuMcA,1034
+drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/try-out-sidebar.css,sha256=tkfQRpX0HTe09dqdjA4GxG5lOCLpw3Mp7VuxkFQtCvI,15829
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/endpoints/variables.css,sha256=Sg2vcQOHdpmEFDn43OeZcMIKxtr5EOEI_wISkCmtcSU,1895
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/animations.css,sha256=IrqN9vJKgaHAWk2PBRKKmFHgH-lQlw5YZvEOGDqYk_g,656
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/base.css,sha256=qdXDVScWoEvFbSRfjDlnxvQZBy2JFX9yXPngMWNSZ7o,1849
@@ -34,17 +36,17 @@ drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/model-tables.css,sha256=8CSy
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/responsive.css,sha256=ygqyUtpiWchTBBIQil1C6mN0AC5xinLoP7whSKfBmwg,944
 drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/models/variables.css,sha256=2HvyjnJrygSzdzpE-FYpo6FGhrYhmZ7NwDFAkADXQNg,1094
 drf_to_mkdoc/utils/__init__.py,sha256=6dFTb07S6yIf-INMy0Mlgf5purNir687ZU9WZtITh4k,68
-drf_to_mkdoc/utils/common.py,sha256=qPF7tfnEsRbf57JJwDCqMtjMFmxmpWguXPQabHkag70,11711
-drf_to_mkdoc/utils/endpoint_detail_generator.py,sha256=mX3sklhWsd-FmOV-ePrhLpg5l8-Eu7V7qb5EL4Tq0FI,27650
+drf_to_mkdoc/utils/common.py,sha256=SxjGe9MtyxTyroXP7QdUiW9QqZ1N7xPjHHaAI-hqYxc,12077
+drf_to_mkdoc/utils/endpoint_detail_generator.py,sha256=vAGQz_DV5wS47hfZNWgI_1oKarLdV5TJ6nwv47uMWw0,27911
 drf_to_mkdoc/utils/endpoint_list_generator.py,sha256=P7pEHscHNHpjDuTXmAUPYV3_t8uGSdaYOgiDGGoCwYc,9705
-drf_to_mkdoc/utils/model_detail_generator.py,sha256=P5kWO-5aWgvyPgzq1qXnt1380ExnrzlOw18zI57P9u0,8063
+drf_to_mkdoc/utils/model_detail_generator.py,sha256=IHxgEW87Z-kxcFVVWqwdc7k7PsZAwXwixddt-tCvLKg,7961
 drf_to_mkdoc/utils/model_list_generator.py,sha256=7gTPwxOxlvvCfDgVPTbGPsLi1gnI47UjMqKc57qRmks,2409
 drf_to_mkdoc/utils/extractors/__init__.py,sha256=BvC8gKOPVI9gU1Piw0jRhKQ2ER5s1moAxgq7ZYkJWNI,86
 drf_to_mkdoc/utils/extractors/query_parameter_extractors.py,sha256=gnDlvF-bxkTp2NcEQf0EZZAfmdQzUpedhZ7N1LAYQzU,8432
 drf_to_mkdoc/utils/md_generators/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 drf_to_mkdoc/utils/md_generators/query_parameters_generators.py,sha256=N-XqZ_FUODSR5V4xM9oEA3aaIiNGNmNwpvrWbQTx6RI,2566
-drf_to_mkdoc-0.1.8.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
-drf_to_mkdoc-0.1.8.dist-info/METADATA,sha256=A_y3wLQBP6TCyeuv40sF-iqeD-UEYLzXQwUTdeem1dI,7037
-drf_to_mkdoc-0.1.8.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-drf_to_mkdoc-0.1.8.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
-drf_to_mkdoc-0.1.8.dist-info/RECORD,,
+drf_to_mkdoc-0.2.0.dist-info/licenses/LICENSE,sha256=3n9_ckIREsH8ogCxWW6dFsw_WfGcluG2mHcgl9i_UU0,1068
+drf_to_mkdoc-0.2.0.dist-info/METADATA,sha256=UL7fU0BVLOoteGIHaJJxpNj2rHw9KXG1-l1xtKXJRno,7037
+drf_to_mkdoc-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+drf_to_mkdoc-0.2.0.dist-info/top_level.txt,sha256=ZzJecR6j_tvLZiubUBEgawHflozC4DQy9ooNf1yDJ3Q,13
+drf_to_mkdoc-0.2.0.dist-info/RECORD,,