Skip to content

Docs - Improve UI #4890

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 8, 2017
Merged

Docs - Improve UI #4890

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6fa5610
Merge remote-tracking branch 'tomchristie/docs' into docs
manosim Feb 8, 2017
189d31e
More padding in the main container & Remove links from parents in sid…
manosim Feb 8, 2017
3ec7d5f
Layout link meta
manosim Feb 8, 2017
d20e0f2
Section & Link Titles
manosim Feb 8, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 41 additions & 2 deletions rest_framework/static/rest_framework/docs/css/base.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
.main-container {
padding-left: 30px;
padding-right: 30px;
}

.sidebar {
overflow: auto;
font-family: verdana;
Expand Down Expand Up @@ -125,6 +130,11 @@
}

@media (max-width: 767px) {
.main-container {
padding-left: 15px;
padding-right: 15px;
}

.sidebar {
position: relative;
width: 100%;
Expand Down Expand Up @@ -176,13 +186,29 @@ body {
padding: 0px;
}

.coredocs-section {
.coredocs-section-title {
margin-top: 20px;
padding-bottom: 10px;
border-bottom: 1px solid lightgrey;
}

.coredocs-section:last-child {
.coredocs-link-title a,
.coredocs-section-title a {
display: none;
}

.coredocs-link-title a,
.coredocs-section-title a {
text-decoration: none;
}

.coredocs-link-title:hover a,
.coredocs-section-title:hover a {
display: inline;
font-size: 20px;
}

.coredocs-section-title:last-child {
margin-top: 0;
}

Expand Down Expand Up @@ -232,11 +258,24 @@ body {

/* @group Docs Content */

.docs-content .meta .label {
vertical-align: middle;
font-size: 14px;
font-weight: normal;
}

.docs-content .meta code {
vertical-align: middle;
padding: .2em .6em .3em;
font-size: 14px;
}

.docs-content .btn {
font-size: inherit;
}

.code-samples pre {
margin-top: 20px;
}

/* @end Docs Content */
4 changes: 3 additions & 1 deletion rest_framework/templates/rest_framework/docs/document.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
{% load rest_framework %}

{% for section_key, section in document.data.items %}
<h2 id="{{ section_key }}" class="coredocs-section"><i class="fa fa-angle-right"></i> {{ section_key }}</h2>
<h2 id="{{ section_key }}" class="coredocs-section-title">{{ section_key }} <a href="#{{ section_key }}"><i class="fa fa-link" aria-hidden="true"></i>
</a></h2>

{% for link_key, link in section.links.items %}
{% include "rest_framework/docs/link.html" %}
{% endfor %}
Expand Down
2 changes: 1 addition & 1 deletion rest_framework/templates/rest_framework/docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

<div class="container" id="main">
<div class="row">
<div class="col-md-12">
<div class="col-md-12 main-container">
{% include "rest_framework/docs/document.html" %}
</div>
</div>
Expand Down
19 changes: 14 additions & 5 deletions rest_framework/templates/rest_framework/docs/link.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,21 @@
<div class="row coredocs-link">

<div class="col-md-6 docs-content">
<button class="btn btn-sm btn-success" style="float: right; margin-top: 20px" data-toggle="modal" data-target="#{{ section_key }}_{{ link_key }}_modal">Interact</button>
<button
class="btn btn-sm btn-success"
style="float: right; margin-top: 20px"
data-toggle="modal"
data-target="#{{ section_key }}_{{ link_key }}_modal">
Interact
</button>

<h3 id="{{ section_key }}-{{ link_key }}">{{ link.title|default:link_key }}</h3>
<p>
<span class="label label-primary">{{ link.action|upper }}</span> <code>{{ link.url }}</code>
</p>
<h3 id="{{ section_key }}-{{ link_key }}" class="coredocs-link-title">{{ link.title|default:link_key }} <a href="#{{ section_key }}-{{ link_key }}"><i class="fa fa-link" aria-hidden="true"></i>
</a></h3>

<div class="meta">
<span class="label label-primary">{{ link.action|upper }}</span>
<code>{{ link.url }}</code>
</div>

<p>{% render_markdown link.description %}</p>

Expand Down
2 changes: 1 addition & 1 deletion rest_framework/templates/rest_framework/docs/sidebar.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ <h3 class="brand">{{ document.title }}</h3>
<ul id="menu-content" class="menu-content collapse out">
{% for section_key, section in document.data.items %}
<li data-toggle="collapse" data-target="#{{ section_key }}-dropdown" class="collapsed">
<a href="#{{ section_key }}"><i class="fa fa-dot-circle-o fa-lg"></i> {{ section_key }} <span class="arrow"></span></a>
<a><i class="fa fa-dot-circle-o fa-lg"></i> {{ section_key }} <span class="arrow"></span></a>
</li>
<ul class="sub-menu collapse in" id="{{ section_key }}-dropdown">
{% for link_key, link in section.links.items %}
Expand Down