drf-to-mkdoc 0.2.1__py3-none-any.whl → 0.2.3__py3-none-any.whl

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/try-out/response.css

@@ -0,0 +1,158 @@
+/* Response Modal */
+.response-modal {
+    position: fixed;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    z-index: var(--try-out-z-response);
+    display: none;
+    align-items: center;
+    justify-content: center;
+    padding: var(--try-out-spacing-lg);
+    box-sizing: border-box;
+}
+
+.response-modal .modal-header {
+    padding: var(--try-out-spacing-lg) var(--try-out-spacing-xl);
+    background: linear-gradient(135deg, var(--try-out-primary), #1565c0);
+    color: white;
+    display: flex;
+    align-items: center;
+    gap: var(--try-out-spacing);
+    flex-shrink: 0;
+    position: relative;
+}
+
+.response-modal .modal-header h3 {
+    margin: 0;
+    font-size: var(--try-out-font-lg);
+    font-weight: 600;
+    flex-grow: 1;
+}
+
+.response-modal .modal-close {
+    background: none;
+    border: none;
+    color: white;
+    cursor: pointer;
+    padding: var(--try-out-spacing-sm);
+    font-size: var(--try-out-font-lg);
+    line-height: 1;
+    border-radius: 50%;
+    width: 28px;
+    height: 28px;
+    display: flex;
+    align-items: center;
+    justify-content: center;
+    position: absolute;
+    right: var(--try-out-spacing);
+    top: 50%;
+    transform: translateY(-50%);
+}
+
+.response-modal .modal-close:hover {
+    background-color: rgba(255, 255, 255, 0.1);
+}
+
+.response-modal .modal-body {
+    padding: var(--try-out-spacing-xl);
+    overflow-y: auto;
+    flex: 1;
+}
+
+.response-modal.show {
+    display: flex;
+}
+
+.response-modal .modal-content {
+    position: relative;
+    width: 100%;
+    max-width: 700px;
+    max-height: 85vh;
+    background-color: var(--try-out-bg);
+    border-radius: var(--try-out-border-radius-lg);
+    box-shadow: 0 8px 32px var(--try-out-shadow-strong);
+    overflow: hidden;
+    z-index: 1;
+    display: flex;
+    flex-direction: column;
+}
+
+.response-modal .response-header {
+    margin-bottom: var(--try-out-spacing-lg);
+    padding: var(--try-out-spacing);
+    border-radius: var(--try-out-border-radius);
+    background-color: var(--try-out-surface);
+    display: flex;
+    align-items: center;
+    gap: var(--try-out-spacing);
+}
+
+.response-modal .status-badge {
+    padding: var(--try-out-spacing-sm) var(--try-out-spacing);
+    border-radius: var(--try-out-border-radius);
+    font-size: var(--try-out-font-sm);
+    font-weight: 600;
+    font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace;
+}
+
+.response-modal .status-200 { 
+    background-color: var(--try-out-success); 
+    color: white; 
+}
+
+.response-modal .status-300 { 
+    background-color: var(--try-out-info); 
+    color: white; 
+}
+
+.response-modal .status-400 { 
+    background-color: var(--try-out-warning); 
+    color: #212529; 
+}
+
+.response-modal .status-500 { 
+    background-color: var(--try-out-danger); 
+    color: white; 
+}
+
+.response-modal .response-body {
+    background-color: var(--try-out-surface);
+    padding: var(--try-out-spacing-lg);
+    border-radius: var(--try-out-border-radius);
+    overflow: auto;
+    font-family: 'Monaco', 'Menlo', 'Ubuntu Mono', monospace;
+    white-space: pre-wrap;
+    font-size: var(--try-out-font-sm);
+    line-height: var(--try-out-line-height);
+    max-height: 300px;
+    border: 1px solid var(--try-out-border);
+    flex: 1;
+}
+
+.response-modal .response-info {
+    display: flex;
+    align-items: center;
+    gap: var(--try-out-spacing);
+    font-size: var(--try-out-font-base);
+    color: var(--try-out-text);
+    font-weight: 500;
+}
+
+/* Mobile Response Modal */
+@media screen and (max-width: 768px) {
+    .response-modal {
+        padding: var(--try-out-spacing-sm);
+    }
+    
+    .response-modal .modal-content {
+        max-width: none;
+        max-height: 90vh;
+    }
+    
+    .response-modal .response-body {
+        font-size: 12px;
+        max-height: 250px;
+    }
+}

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/try-out/tabs.css

@@ -0,0 +1,62 @@
+/* Tabs */
+.tabs {
+    display: flex;
+    gap: 0;
+    margin-bottom: var(--try-out-spacing-lg);
+    border: 1px solid var(--try-out-border);
+    border-radius: var(--try-out-border-radius);
+    overflow: hidden;
+    background-color: var(--try-out-surface);
+}
+
+.tab {
+    flex: 1;
+    padding: var(--try-out-spacing) var(--try-out-spacing-lg);
+    border: none;
+    background: transparent;
+    color: var(--try-out-text-light);
+    cursor: pointer;
+    font-size: var(--try-out-font-base);
+    font-weight: 500;
+    position: relative;
+    transition: var(--try-out-transition);
+    border-right: 1px solid var(--try-out-border);
+}
+
+.tab:last-child {
+    border-right: none;
+}
+
+.tab:hover {
+    background-color: rgba(25, 118, 210, 0.05);
+    color: var(--try-out-text);
+}
+
+.tab.active {
+    background-color: var(--try-out-primary);
+    color: white;
+}
+
+.tab-content {
+    display: none;
+}
+
+.tab-content.active {
+    display: block;
+}
+
+/* Mobile Tabs */
+@media screen and (max-width: 768px) {
+    .tabs {
+        flex-direction: column;
+    }
+    
+    .tab {
+        border-right: none;
+        border-bottom: 1px solid var(--try-out-border);
+    }
+    
+    .tab:last-child {
+        border-bottom: none;
+    }
+}

drf_to_mkdoc/static/drf-to-mkdoc/stylesheets/try-out/variables.css

@@ -0,0 +1,38 @@
+:root {
+    --try-out-primary: #1976d2;
+    --try-out-primary-hover: #1565c0;
+    --try-out-success: #28a745;
+    --try-out-success-hover: #218838;
+    --try-out-danger: #dc3545;
+    --try-out-danger-hover: #c82333;
+    --try-out-warning: #ffc107;
+    --try-out-info: #17a2b8;
+    
+    --try-out-bg: #ffffff;
+    --try-out-surface: #f8f9fa;
+    --try-out-border: #e1e5e9;
+    --try-out-text: #333333;
+    --try-out-text-light: #666666;
+    --try-out-text-lighter: #999999;
+    --try-out-shadow: rgba(0, 0, 0, 0.1);
+    --try-out-shadow-strong: rgba(0, 0, 0, 0.2);
+    
+    --try-out-border-radius: 4px;
+    --try-out-border-radius-lg: 6px;
+    --try-out-spacing-xs: 0.2rem;
+    --try-out-spacing-sm: 0.4rem;
+    --try-out-spacing: 0.6rem;
+    --try-out-spacing-lg: 0.8rem;
+    --try-out-spacing-xl: 1.2rem;
+    --try-out-spacing-xxl: 1.6rem;
+    
+    --try-out-font-sm: 0.75rem;
+    --try-out-font-base: 0.8rem;
+    --try-out-font-lg: 0.9rem;
+    --try-out-line-height: 1.4;
+    
+    --try-out-transition: all 0.2s ease;
+    --try-out-z-modal: 1000;
+    --try-out-z-response: 1100;
+    --try-out-z-fab: 100;
+}

drf_to_mkdoc/templates/endpoints/detail/base.html

@@ -0,0 +1,35 @@
+<!-- inject CSS and JS directly -->
+{% load custom_filters %}
+{% for stylesheet in stylesheets %}
+<link rel="stylesheet" href="{% static_with_prefix stylesheet prefix_path %}">
+{% endfor %}
+{% for script in scripts %}
+<script src="{% static_with_prefix script prefix_path %}" defer></script>
+{% endfor %}
+
+# {{ method|upper }} {{ path }}
+
+{{ method|format_method_badge|safe }} `{{ path }}`
+
+**View class:** {{ viewset_name }}
+
+{% if summary %}
+## Overview
+
+{{ summary }}
+{% endif %}
+
+{% if operation_id %}
+**Operation ID:** `{{ operation_id }}`
+{% endif %}
+
+{% if description %}
+{{ description|safe }}
+{% endif %}
+
+{% include "endpoints/detail/path_parameters.html" %}
+{% include "endpoints/detail/query_parameters.html" %}
+{% include "endpoints/detail/request_body.html" %}
+{% include "endpoints/detail/responses.html" %}
+
+{% include 'try-out/main.html' %}

drf_to_mkdoc/templates/endpoints/detail/path_parameters.html

@@ -0,0 +1,8 @@
+{% if path_params %}
+## Path Parameters
+
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+{% for param in path_params %}| `{{ param.name }}` | `{{ param.schema.type|default:"string" }}` | {{ param.required|yesno:"Yes,No" }} | {{ param.description }} |{% endfor %}
+{% endif %}
+

drf_to_mkdoc/templates/endpoints/detail/query_parameters.html

@@ -0,0 +1,36 @@
+{% comment %}
+Check if any query parameter fields have content
+{% endcomment %}
+
+{% if query_parameters.filter_fields or query_parameters.search_fields or query_parameters.ordering_fields or query_parameters.pagination_fields %}
+## Query Parameters
+
+{% if query_parameters.filter_fields %}
+### Filter Fields
+{% for field in query_parameters.filter_fields %}
+- `{{ field }}`
+{% endfor %}
+{% endif %}
+
+{% if query_parameters.search_fields %}
+### Search Fields
+{% for field in query_parameters.search_fields %}
+- `{{ field }}`
+{% endfor %}
+{% endif %}
+
+{% if query_parameters.ordering_fields %}
+### Ordering Fields
+{% for field in query_parameters.ordering_fields %}
+- `{{ field }}`
+{% endfor %}
+{% endif %}
+
+{% if query_parameters.pagination_fields %}
+### Pagination Fields
+{% for field in query_parameters.pagination_fields %}
+- `{{ field }}`
+{% endfor %}
+{% endif %}
+
+{% endif %}

drf_to_mkdoc/templates/endpoints/detail/request_body.html

@@ -0,0 +1,10 @@
+{% load custom_filters %}
+
+{% if request_body %}
+## Request Body
+
+{% if request_example %}
+{{ request_example|format_json }}
+{% endif %}
+
+{% endif %}

drf_to_mkdoc/templates/endpoints/detail/responses.html

@@ -0,0 +1,18 @@
+{% load custom_filters %}
+
+{% if responses %}
+## Responses
+
+{% for response in responses %}
+### {{ response.status_code }}
+
+{% if response.description %}
+{{ response.description }}
+{% endif %}
+
+{% for example in response.examples %}
+{{ example|format_json }}
+{% endfor %}
+
+{% endfor %}
+{% endif %}

drf_to_mkdoc/templates/endpoints/list/base.html

@@ -0,0 +1,23 @@
+# API Endpoints
+
+<style>
+{% for stylesheet in stylesheets %}
+@import url("{{ stylesheet|safe }}");
+{% endfor %}
+</style>
+
+{% for script in scripts %}
+<script src="{{ script|safe }}" defer></script>
+{% endfor %}
+
+<div class="main-content">
+    {% include "endpoints/list/filter_section.html" %}
+    {% for app_name, endpoints in endpoints_by_app.items %}
+        <h2>{{ app_name|title }}</h2>
+        <div class="endpoints-grid">
+            {% for endpoint in endpoints %}
+                {% include "endpoints/list/endpoint_card.html" %}
+            {% endfor %}
+        </div>
+    {% endfor %}
+</div>

drf_to_mkdoc/templates/endpoints/list/endpoint_card.html

@@ -0,0 +1,18 @@
+{% load custom_filters %}
+<a href="{{ endpoint.link_url }}" class="endpoint-card"
+    data-method="{{ endpoint.method|lower }}"
+    data-path="{{ endpoint.path|lower }}"
+    data-app="{{ app_name|lower }}"
+    data-auth="{{ endpoint.auth_required|default:'false'|lower }}"
+    data-pagination="{{ endpoint.pagination_support|default:'false'|lower }}"
+    data-search="{{ endpoint.view_class.search_fields|default:''|length|yesno:'true,false'|lower }}"
+    data-ordering="{{ endpoint.ordering_support|default:'false'|lower }}"
+    data-models="{{ endpoint.related_models|default:''|join:' '|lower }}"
+    data-roles="{{ endpoint.permission_roles|default:''|join:' '|lower }}"
+    data-content-type="{{ endpoint.content_type|default:''|lower }}"
+    data-tags="{{ endpoint.tags|default:''|join:' '|lower }}"
+    data-schema="{{ endpoint.schema_fields|default:''|join:' '|lower }}"
+    data-params="{{ endpoint.query_parameters|default:''|join:' '|lower }}">
+    <span class="method-badge method-{{ endpoint.method|lower }}">{{ endpoint.method }}</span>
+    <span class="endpoint-path">{{ endpoint.path }}</span>
+</a>

drf_to_mkdoc/templates/endpoints/list/filter_section.html

@@ -0,0 +1,16 @@
+<div class="filter-sidebar collapsed" id="filterSidebar">
+    <h3 class="filter-title">🔍 Filters</h3>
+    <div class="filter-grid">
+        {% for filter_key in active_filters %}
+            {% include "endpoints/list/filters/"|add:filter_key|add:".html" %}
+        {% endfor %}
+    </div>
+
+    <div class="filter-actions">
+        <button class="filter-apply" onclick="applyFilters()">Apply</button>
+        <button class="filter-clear" onclick="clearFilters()">Clear</button>
+    </div>
+
+    <div class="filter-results">Showing 0 endpoints</div>
+</div>
+

drf_to_mkdoc/templates/endpoints/list/filters/app.html

@@ -0,0 +1,8 @@
+<div class="filter-group">
+    <label class="filter-label">Django App</label>
+    <select id="filter-app" class="filter-select">
+        <option value="">All</option>
+        <!-- Dynamically filled -->
+    </select>
+</div>
+

drf_to_mkdoc/templates/endpoints/list/filters/method.html

@@ -0,0 +1,12 @@
+<div class="filter-group">
+    <label class="filter-label">HTTP Method</label>
+    <select id="filter-method" class="filter-select">
+        <option value="">All</option>
+        <option value="get">GET</option>
+        <option value="post">POST</option>
+        <option value="put">PUT</option>
+        <option value="patch">PATCH</option>
+        <option value="delete">DELETE</option>
+    </select>
+</div>
+

drf_to_mkdoc/templates/endpoints/list/filters/path.html

@@ -0,0 +1,5 @@
+<div class="filter-group">
+    <label class="filter-label">Endpoint Path</label>
+    <input type="text" id="filter-path" class="filter-input" placeholder="Search path...">
+</div>
+

drf_to_mkdoc/templates/endpoints/list/filters/search.html

@@ -0,0 +1,9 @@
+<div class="filter-group">
+    <label class="filter-label">Search Support</label>
+    <select id="filter-search" class="filter-select">
+        <option value="">All</option>
+        <option value="true">Yes</option>
+        <option value="false">No</option>
+    </select>
+</div>
+

drf_to_mkdoc/templates/model_detail/base.html

@@ -0,0 +1,34 @@
+# {{ name }}
+
+<!-- inject CSS directly -->
+{% for stylesheet in stylesheets %}
+<link rel="stylesheet" href="{{ stylesheet }}">
+{% endfor %}
+
+**App:** {{ app_label }}
+
+**Table:** `{{ table_name }}`
+
+## Description
+
+{{ description }}
+
+{% if fields %}
+{% include "model_detail/fields.html" with fields=fields %}
+{% endif %}
+
+{% if has_choices %}
+{% include "model_detail/choices.html" with fields=fields %}
+{% endif %}
+
+{% if relationships %}
+{% include "model_detail/relationships.html" with relationships=relationships %}
+{% endif %}
+
+{% if methods %}
+{% include "model_detail/methods.html" with methods=methods %}
+{% endif %}
+
+{% if meta_options %}
+{% include "model_detail/meta.html" with meta_options=meta_options %}
+{% endif %}

drf_to_mkdoc/templates/model_detail/choices.html

@@ -0,0 +1,12 @@
+{% load custom_filters %}
+## Choices
+
+{% for field_name, field_info in fields.items %}{% if field_info.choices %}
+### {{ field_name }} Choices
+
+| Label | Value |
+|-------|-------|
+{% for choice in field_info.choices %}| {{ choice.display }} | `{{ choice.value }}` |
+{% endfor %}
+
+{% endif %}{% endfor %}

drf_to_mkdoc/templates/model_detail/fields.html

@@ -0,0 +1,11 @@
+{% load custom_filters %}
+## Fields
+
+| Field | Type | Description | Extra |
+|-------|------|-------------|-------|
+{% for field_name, field_info in fields.items %}{% with field_type=field_info.type|default:"Unknown" %}{% if field_type == "TextField" %}| `{{ field_name }}` | TextField | {{ field_name }} | {% if field_info.max_length %}max_length={{ field_info.max_length }}{% endif %} |
+{% elif field_type == "BigAutoField" %}| `{{ field_name }}` | BigAutoField | ID | {% if field_info.blank %}blank=True{% endif %}{% if field_info.unique %}, unique=True{% endif %}{% if field_info.primary_key %}, primary_key=True{% endif %} |
+{% elif field_type == "CharField" %}| `{{ field_name }}` | CharField | {{ field_name }} | {% if field_info.max_length %}max_length={{ field_info.max_length }}{% endif %}{% if field_info.null %}, null=True{% endif %}{% if field_info.blank %}, blank=True{% endif %} |
+{% elif field_type == "ForeignKey" %}| `{{ field_name }}` | ForeignKey | {{ field_info.field_specific.to|default:"" }} | |
+{% else %}| `{{ field_name }}` | {{ field_type }} | {{ field_name }} | {{ field_info|format_field_extra }} |
+{% endif %}{% endwith %}{% endfor %}

drf_to_mkdoc/templates/model_detail/meta.html

@@ -0,0 +1,6 @@
+## Meta Options
+
+{% for option, value in meta_options.items %}
+- **{{ option }}:** {{ value }}
+{% endfor %}
+

drf_to_mkdoc/templates/model_detail/methods.html

@@ -0,0 +1,9 @@
+## Methods
+
+{% for method in methods %}
+### `{{ method.name }}()`
+
+{{ method.docstring|default:"No documentation available." }}
+
+{% endfor %}
+

drf_to_mkdoc/templates/model_detail/relationships.html

@@ -0,0 +1,8 @@
+{% load custom_filters %}
+## Relationships
+
+| Field | Type | Related Model |
+|-------|------|---------------|
+{% for field_name, field_info in relationships.items %}{% with field_type=field_info.type|default:"Unknown" %}{% if field_info.field_specific.to %}| `{{ field_name }}` | {{ field_type }} | {% if "." in field_info.field_specific.to %}[{{ field_info.field_specific.to|cut:"." }}](../{{ field_info.field_specific.to|cut:"." }}/{% else %}[{{ field_info.field_specific.to }}]({{ field_info.field_specific.to|lower }}/{% endif %} |
+{% endif %}{% endwith %}{% endfor %}{% for rel_name, rel_info in relationships.items %}| `{{ rel_name }}` | {{ rel_info.type|default:"Unknown" }} | [{{ rel_info.verbose_name|capfirst }}](../../{{ rel_info.app_label }}/{{ rel_info.table_name }}/) |
+{% endfor %}

drf_to_mkdoc/templates/models_index.html

@@ -0,0 +1,24 @@
+{% load custom_filters %}
+# Django Models
+
+This section contains documentation for all Django models in the system, organized by Django application.
+
+<!-- inject CSS directly -->
+{% for css in stylesheets %}
+<link rel="stylesheet" href="{{ css }}">
+{% endfor %}
+
+<div class="models-container">
+{% for app_name, models in sorted_models %}
+    <div class="app-header">{{ app_name|title|cut:"_"|safe }}</div>
+    <div class="app-description">{{ app_descriptions|get_item:app_name }}</div>
+
+    <div class="model-cards">
+    {% for verbose_name, table_name in models %}
+        <a href="{{ app_name|urlencode }}/{{ table_name|urlencode }}/" class="model-card">{{ verbose_name }}</a>
+    {% endfor %}
+    </div>
+{% endfor %}
+</div>
+
+Each model page contains detailed field documentation, method signatures, and relationships to other models.

drf_to_mkdoc/templates/try-out/fab.html

@@ -0,0 +1,4 @@
+<!-- Try Out Floating Action Button -->
+<button class="try-out-fab" role="button" tabindex="0" aria-label="Open Try It Out" onclick="TryOutSidebar.openTryOut()">
+    <span>🚀</span>
+</button>