From 9c18c38da696a0229bc0aaea1bff287caa2fe789 Mon Sep 17 00:00:00 2001 From: Emmanuelle Delescolle Date: Fri, 10 Mar 2017 20:31:57 +0100 Subject: [PATCH] fix #4965 --- .../docs/_recursive_document.html | 15 +++++++++++++++ .../rest_framework/docs/_recursive_menu.html | 17 +++++++++++++++++ .../rest_framework/docs/document.html | 11 +---------- .../rest_framework/docs/interact.html | 2 +- .../rest_framework/docs/langs/javascript.html | 2 +- .../rest_framework/docs/langs/python.html | 2 +- .../rest_framework/docs/langs/shell.html | 2 +- .../templates/rest_framework/docs/link.html | 2 +- .../rest_framework/docs/sidebar.html | 13 +------------ rest_framework/templatetags/rest_framework.py | 19 +++++++++++++++++++ 10 files changed, 58 insertions(+), 27 deletions(-) create mode 100644 rest_framework/templates/rest_framework/docs/_recursive_document.html create mode 100644 rest_framework/templates/rest_framework/docs/_recursive_menu.html diff --git a/rest_framework/templates/rest_framework/docs/_recursive_document.html b/rest_framework/templates/rest_framework/docs/_recursive_document.html new file mode 100644 index 000000000..d0f904aa3 --- /dev/null +++ b/rest_framework/templates/rest_framework/docs/_recursive_document.html @@ -0,0 +1,15 @@ +{% for section_key, section in items %} +{% if section_key %} + {{ section_key }} + +{% endif %} + + {% if section.links.items %} + {% for link_key, link in section.links.items %} + {% include "rest_framework/docs/link.html" with prefix=prefix level=level|add:1%} + {% endfor %} + {% else %} + {% include 'rest_framework/docs/_recursive_document.html' with items=section.items prefix=prefix|add:section_key|add:'/' level=level|add:1 %} + {% endif %} +{% endfor %} + diff --git a/rest_framework/templates/rest_framework/docs/_recursive_menu.html b/rest_framework/templates/rest_framework/docs/_recursive_menu.html new file mode 100644 index 000000000..d00a16747 --- /dev/null +++ b/rest_framework/templates/rest_framework/docs/_recursive_menu.html @@ -0,0 +1,17 @@ + + diff --git a/rest_framework/templates/rest_framework/docs/document.html b/rest_framework/templates/rest_framework/docs/document.html index ef5f5966b..5a3948d17 100644 --- a/rest_framework/templates/rest_framework/docs/document.html +++ b/rest_framework/templates/rest_framework/docs/document.html @@ -14,16 +14,7 @@ -{% for section_key, section in document.data|items %} -{% if section_key %} -

{{ section_key }} -

-{% endif %} - - {% for link_key, link in section.links|items %} - {% include "rest_framework/docs/link.html" %} - {% endfor %} -{% endfor %} +{% include 'rest_framework/docs/_recursive_document.html' with items=document.data|items level=2 %} {% for link_key, link in document.links|items %} {% include "rest_framework/docs/link.html" %} diff --git a/rest_framework/templates/rest_framework/docs/interact.html b/rest_framework/templates/rest_framework/docs/interact.html index 3703301c2..4d2f8b063 100644 --- a/rest_framework/templates/rest_framework/docs/interact.html +++ b/rest_framework/templates/rest_framework/docs/interact.html @@ -16,7 +16,7 @@ -
+
diff --git a/rest_framework/templates/rest_framework/docs/langs/javascript.html b/rest_framework/templates/rest_framework/docs/langs/javascript.html index 4a51a32fd..d419a6017 100644 --- a/rest_framework/templates/rest_framework/docs/langs/javascript.html +++ b/rest_framework/templates/rest_framework/docs/langs/javascript.html @@ -6,7 +6,7 @@ var schema = window.schema // Loaded by `schema.js` var client = new coreapi.Client() // Interact with the API endpoint -var action = [{% if section_key %}"{{ section_key }}", {% endif %}"{{ link_key }}"] +var action = [{% if prefix %}{{ prefix|split_keys }} {% endif %}{% if section_key %}"{{ section_key }}", {% endif %}"{{ link_key }}"] {% if link.fields %}var params = { {% for field in link.fields %} {{ field.name }}: ...{% if not loop.last %},{% endif %} {% endfor %}} diff --git a/rest_framework/templates/rest_framework/docs/langs/python.html b/rest_framework/templates/rest_framework/docs/langs/python.html index f944daaff..c9d572b86 100644 --- a/rest_framework/templates/rest_framework/docs/langs/python.html +++ b/rest_framework/templates/rest_framework/docs/langs/python.html @@ -6,7 +6,7 @@ client = coreapi.Client() schema = client.get("{{ document.url }}"{% if schema_format %}, format="{{ schema_format }}"{% endif %}) # Interact with the API endpoint -action = [{% if section_key %}"{{ section_key }}", {% endif %}"{{ link_key }}"] +action = [{% if prefix %}{{ prefix|split_keys }} {% endif %}{% if section_key %}"{{ section_key }}", {% endif %}"{{ link_key }}"] {% if link.fields %}params = { {% for field in link.fields %} "{{ field.name }}": ...{% if not loop.last %},{% endif %} {% endfor %}} diff --git a/rest_framework/templates/rest_framework/docs/langs/shell.html b/rest_framework/templates/rest_framework/docs/langs/shell.html index d2744920c..9ccaaaa16 100644 --- a/rest_framework/templates/rest_framework/docs/langs/shell.html +++ b/rest_framework/templates/rest_framework/docs/langs/shell.html @@ -3,4 +3,4 @@ $ coreapi get {{ document.url }}{% if schema_format %} --format {{ schema_format }}{% endif %} # Interact with the API endpoint -$ coreapi action {% if section_key %}{{ section_key }} {% endif %}{{ link_key }}{% for field in link.fields %} -p {{ field.name }}=...{% endfor %}{% endcode %} +$ coreapi action {% if prefix %}{{ prefix|split_keys:'cmd' }} {% endif %}{% if section_key %}{{ section_key }} {% endif %}{{ link_key }}{% for field in link.fields %} -p {{ field.name }}=...{% endfor %}{% endcode %} diff --git a/rest_framework/templates/rest_framework/docs/link.html b/rest_framework/templates/rest_framework/docs/link.html index ae8c7b700..0f199f440 100644 --- a/rest_framework/templates/rest_framework/docs/link.html +++ b/rest_framework/templates/rest_framework/docs/link.html @@ -10,7 +10,7 @@ Interact -