drf-to-mkdoc 0.1.5__py3-none-any.whl → 1.0.7__py3-none-any.whl

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/extra.css

@@ -0,0 +1,358 @@
+/* Custom styles for Tabib API Documentation */
+
+/* Status badges for HTTP methods */
+.method-badge {
+    display: inline-block;
+    padding: 2px 8px;
+    border-radius: 4px;
+    font-size: 0.8em;
+    font-weight: bold;
+    color: white;
+    margin-right: 8px;
+}
+
+.method-get { background-color: #28a745; }
+.method-post { background-color: #007bff; }
+.method-put { background-color: #ffc107; color: #212529; }
+.method-patch { background-color: #6f42c1; }
+.method-delete { background-color: #dc3545; }
+
+/* Enhanced code blocks */
+.highlight pre {
+    border-left: 4px solid var(--md-primary-fg-color);
+    background-color: var(--md-code-bg-color);
+    padding: 1rem;
+    border-radius: 0.2rem;
+}
+
+/* Model field tables */
+table {
+    border-collapse: collapse;
+    width: 100%;
+    margin: 1rem 0;
+}
+
+table th {
+    background-color: var(--md-primary-fg-color--light);
+    color: var(--md-primary-bg-color);
+    padding: 0.75rem;
+    text-align: left;
+    font-weight: 600;
+}
+
+table td {
+    padding: 0.75rem;
+    border-bottom: 1px solid var(--md-default-fg-color--lightest);
+}
+
+table tr:hover {
+    background-color: var(--md-accent-fg-color--transparent);
+}
+
+/* Field and method grids */
+.field-grid, .method-grid {
+    display: grid;
+    grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
+    gap: 1rem;
+    margin: 1rem 0;
+}
+
+.field-item, .method-item {
+    background-color: var(--md-default-bg-color);
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 0.2rem;
+    padding: 1rem;
+}
+
+.field-item h4, .method-item h4 {
+    margin-top: 0;
+    color: var(--md-primary-fg-color);
+}
+
+/* API endpoint sections */
+.endpoint-section {
+    border-left: 4px solid var(--md-accent-fg-color);
+    padding-left: 1rem;
+    margin: 2rem 0;
+}
+
+.endpoint-header {
+    display: flex;
+    align-items: center;
+    margin-bottom: 1rem;
+}
+
+.endpoint-path {
+    font-family: var(--md-code-font);
+    background-color: var(--md-code-bg-color);
+    padding: 0.2rem 0.5rem;
+    border-radius: 0.2rem;
+    margin-left: 0.5rem;
+}
+
+/* Navigation enhancements */
+.md-nav__item--active > .md-nav__link {
+    font-weight: 600;
+}
+
+/* Admonition customizations */
+.admonition.note {
+    border-left-color: var(--md-primary-fg-color);
+}
+
+.admonition.tip {
+    border-left-color: #00c853;
+}
+
+.admonition.warning {
+    border-left-color: #ff9800;
+}
+
+.admonition.danger {
+    border-left-color: #f44336;
+}
+
+/* Search result enhancements */
+.md-search-result__meta {
+    color: var(--md-default-fg-color--light);
+}
+
+/* Responsive design improvements */
+@media screen and (max-width: 768px) {
+    .field-grid, .method-grid {
+        grid-template-columns: 1fr;
+    }
+    
+    .endpoint-header {
+        flex-direction: column;
+        align-items: flex-start;
+    }
+    
+    .endpoint-path {
+        margin-left: 0;
+        margin-top: 0.5rem;
+    }
+}
+
+/* Code syntax highlighting enhancements */
+.codehilite .k { color: #0066cc; }  /* Keywords */
+.codehilite .s { color: #009900; }  /* Strings */
+.codehilite .c { color: #999999; }  /* Comments */
+.codehilite .n { color: #333333; }  /* Names */
+.codehilite .o { color: #666666; }  /* Operators */
+
+/* Dark mode adjustments */
+[data-md-color-scheme="slate"] .field-item,
+[data-md-color-scheme="slate"] .method-item {
+    background-color: var(--md-code-bg-color);
+    border-color: var(--md-default-fg-color--lightest);
+}
+
+[data-md-color-scheme="slate"] table th {
+    background-color: var(--md-primary-fg-color);
+    color: var(--md-primary-bg-color);
+}
+
+/* Custom icons for different sections */
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="models"] {
+    position: relative;
+}
+
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="models"]::before {
+    content: "🗃️";
+    margin-right: 0.5rem;
+}
+
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="endpoints"] {
+    position: relative;
+}
+
+.md-nav__item[data-md-level="1"] > .md-nav__link[href*="endpoints"]::before {
+    content: "🔗";
+    margin-right: 0.5rem;
+}
+
+/* Print styles */
+@media print {
+    .md-header, .md-sidebar, .md-footer {
+        display: none;
+    }
+    
+    .md-content {
+        margin: 0;
+    }
+    
+    .highlight pre {
+        border: 1px solid #ccc;
+        page-break-inside: avoid;
+    }
+}
+
+/* =================== DJANGO MODELS CARD LAYOUT =================== */
+
+/* Models container */
+.models-container {
+    max-width: 100%;
+    margin: 0 auto;
+}
+
+/* App description styling */
+.app-description {
+    font-size: 1rem;
+    color: var(--md-default-fg-color--light);
+    margin-bottom: 1.5rem;
+    padding: 0.5rem 0;
+    border-bottom: 1px solid var(--md-default-fg-color--lightest);
+}
+
+/* Model cards grid */
+.model-cards {
+    display: grid;
+    grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
+    gap: 1.5rem;
+    margin-bottom: 3rem;
+}
+
+/* Individual model card */
+.model-card {
+    background: var(--md-default-bg-color);
+    border: 1px solid var(--md-default-fg-color--lightest);
+    border-radius: 8px;
+    padding: 1.5rem;
+    transition: all 0.3s ease;
+    box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+    position: relative;
+    overflow: hidden;
+}
+
+.model-card:hover {
+    transform: translateY(-4px);
+    box-shadow: 0 8px 16px rgba(0, 0, 0, 0.15);
+    border-color: var(--md-primary-fg-color);
+}
+
+.model-card::before {
+    content: '';
+    position: absolute;
+    top: 0;
+    left: 0;
+    right: 0;
+    height: 4px;
+    background: linear-gradient(90deg, var(--md-primary-fg-color), var(--md-accent-fg-color));
+    opacity: 0;
+    transition: opacity 0.3s ease;
+}
+
+.model-card:hover::before {
+    opacity: 1;
+}
+
+/* Model header */
+.model-header {
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+    margin-bottom: 0.5rem;
+}
+
+.model-header h3 {
+    margin: 0;
+    font-size: 1.25rem;
+    font-weight: 600;
+}
+
+.model-header h3 a {
+    color: var(--md-default-fg-color);
+    text-decoration: none;
+    transition: color 0.3s ease;
+}
+
+.model-header h3 a:hover {
+    color: var(--md-primary-fg-color);
+}
+
+/* Model badge */
+.model-badge {
+    display: inline-block;
+    padding: 0.25rem 0.75rem;
+    background: var(--md-primary-fg-color);
+    color: var(--md-primary-bg-color);
+    border-radius: 20px;
+    font-size: 0.75rem;
+    font-weight: 600;
+    text-transform: uppercase;
+    letter-spacing: 0.5px;
+}
+
+/* Dark mode adjustments for model cards */
+[data-md-color-scheme="slate"] .model-card {
+    background: var(--md-code-bg-color);
+    border-color: var(--md-default-fg-color--lightest);
+}
+
+[data-md-color-scheme="slate"] .model-card:hover {
+    border-color: var(--md-primary-fg-color);
+    box-shadow: 0 8px 16px rgba(255, 255, 255, 0.1);
+}
+
+[data-md-color-scheme="slate"] .app-description {
+    color: var(--md-default-fg-color--light);
+    border-color: var(--md-default-fg-color--lightest);
+}
+
+/* Responsive adjustments for model cards */
+@media screen and (max-width: 768px) {
+    .model-cards {
+        grid-template-columns: 1fr;
+        gap: 1rem;
+    }
+    
+    .model-card {
+        padding: 1rem;
+    }
+    
+    .model-header h3 {
+        font-size: 1.1rem;
+    }
+    
+    .model-badge {
+        font-size: 0.7rem;
+        padding: 0.2rem 0.6rem;
+    }
+}
+
+@media screen and (max-width: 480px) {
+    .model-header {
+        flex-direction: column;
+        align-items: flex-start;
+        gap: 0.5rem;
+    }
+    
+    .model-badge {
+        align-self: flex-start;
+    }
+}
+
+/* Animation for cards appearing */
+@keyframes fadeInUp {
+    from {
+        opacity: 0;
+        transform: translateY(20px);
+    }
+    to {
+        opacity: 1;
+        transform: translateY(0);
+    }
+}
+
+.model-card {
+    animation: fadeInUp 0.6s ease-out;
+}
+
+/* Stagger animation for multiple cards */
+.model-card:nth-child(1) { animation-delay: 0.1s; }
+.model-card:nth-child(2) { animation-delay: 0.2s; }
+.model-card:nth-child(3) { animation-delay: 0.3s; }
+.model-card:nth-child(4) { animation-delay: 0.4s; }
+.model-card:nth-child(5) { animation-delay: 0.5s; }
+.model-card:nth-child(6) { animation-delay: 0.6s; } 

drf_to_mkdoc/utils/common.py

@@ -1,19 +1,21 @@
-from asyncio.log import logger
 import importlib
-import yaml
 import json
 import re
+from asyncio.log import logger
 from functools import lru_cache
 from pathlib import Path
-from typing import Any, Optional
+from typing import Any
 
+import yaml
 from django.apps import apps
 from django.core.exceptions import AppRegistryNotReady
 from django.urls import resolve
 from django.utils.module_loading import import_string
 from drf_spectacular.generators import SchemaGenerator
+
 from drf_to_mkdoc.conf.settings import drf_to_mkdoc_settings
 
+
 class SchemaValidationError(Exception):
     """Custom exception for schema validation errors."""
 
@@ -37,9 +39,10 @@ def substitute_path_params(path: str, parameters: list[dict[str, Any]]) -> str:
     django_path = re.sub(r"<path:[^>]+>", "dummy/path", django_path)
     django_path = re.sub(r"<[^:>]+>", "dummy", django_path)  # Catch remaining simple params
 
-    return django_path
+    return django_path  # noqa: RET504
+
 
-def load_schema() -> Optional[dict[str, Any]]:
+def load_schema() -> dict[str, Any] | None:
     """Load the OpenAPI schema from doc-schema.yaml"""
     schema_file = Path(drf_to_mkdoc_settings.CONFIG_DIR) / "doc-schema.yaml"
     if not schema_file.exists():
@@ -49,7 +52,7 @@ def load_schema() -> Optional[dict[str, Any]]:
         return yaml.safe_load(f)
 
 
-def load_model_json_data() -> Optional[dict[str, Any]]:
+def load_model_json_data() -> dict[str, Any] | None:
     """Load the JSON mapping data for model information"""
     json_file = Path(drf_to_mkdoc_settings.MODEL_DOCS_FILE)
     if not json_file.exists():
@@ -59,7 +62,7 @@ def load_model_json_data() -> Optional[dict[str, Any]]:
         return json.load(f)
 
 
-def load_doc_config() -> Optional[dict[str, Any]]:
+def load_doc_config() -> dict[str, Any] | None:
     """Load the documentation configuration file"""
     config_file = Path(drf_to_mkdoc_settings.DOC_CONFIG_FILE)
     if not config_file.exists():
@@ -69,7 +72,7 @@ def load_doc_config() -> Optional[dict[str, Any]]:
         return json.load(f)
 
 
-def get_model_docstring(class_name: str) -> Optional[str]:
+def get_model_docstring(class_name: str) -> str | None:
     """Extract docstring from Django model class"""
     try:
         # Check if Django is properly initialized
@@ -167,19 +170,20 @@ def get_custom_schema():
                     raise QueryParamTypeError("Invalid queryparam_type")
     return data
 
+
 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 DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR is set, use that function instead.
+    If PATH_PARAM_SUBSTITUTOR is set, use that function instead.
     """
     function = None
-    func_path = getattr(drf_to_mkdoc_settings, "DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR", None)
+    func_path = getattr(drf_to_mkdoc_settings, "PATH_PARAM_SUBSTITUTOR", None)
 
     if func_path:
         try:
             function = import_string(func_path)
         except ImportError:
-            logger.warning("DRF_TO_MKDOC_PATH_PARAM_SUBSTITUTOR is not a valid import path")
+            logger.warning("PATH_PARAM_SUBSTITUTOR is not a valid import path")
 
     # If custom function exists and returns a valid value, use it
     if callable(function):
@@ -193,26 +197,27 @@ def convert_to_django_path(path: str, parameters: list[dict[str, Any]]) -> str:
     # 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'
+        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'
+            converter = "str"
 
-        return f'<{converter}:{param_name}>'
+        return f"<{converter}:{param_name}>"
 
-    django_path = re.sub(r'{(\w+)}', replacement, path)
+    django_path = re.sub(r"{(\w+)}", replacement, path)
 
-    if not django_path.endswith('/'):
-        django_path += '/'
+    if not django_path.endswith("/"):
+        django_path += "/"
 
     return django_path
 
+
 @lru_cache
 def get_schema():
     base_schema = SchemaGenerator().get_schema(request=None, public=True)
@@ -291,8 +296,8 @@ def extract_viewset_from_operation_id(operation_id: str):
         else:
             return view_func
 
-    except Exception as e:
-        raise RuntimeError(f"Failed to resolve path {django_path}: {e}") from e
+    except Exception:
+        logger.error(f"Failed to resolve path {path}")
 
 
 def extract_viewset_name_from_operation_id(operation_id: str):