sagi/se-hub
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Changed AutoDoc layout

Browse source
This commit is contained in:
Sagi Dayan 2015-06-14 16:39:14 +03:00
parent ba15613417
commit f8469f5301
2 changed files with 68 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
SE_API/API.py
View file

@ -49,11 +49,20 @@ def wellcomePage():
@auto.doc()
def confirm_user_to_campus(validation_token):
"""
This Function is will re
:param validation_token: 'seToken|email_suffix'
<span class="card-title">This Function is will Activate a user and add tha campus to it</span>
<br>
<b>Route Parameters</b>
<ul>
<li>
validation_token: 'seToken|email_suffix'
</li>
</ul>
:return:
200 - redirect to home + new cookie
403 - Invalid Token
<code>main(){
asd = 3
}</code>
"""
#TODO
token = str(validation_token).split('|')[0]
@ -83,7 +92,7 @@ def send_activation(token):
This Method Will Send An Email To The User - To Confirm his Account
:param token: - seToken
:payload: JSON - {email: 'academic@email.ac.com'}
:return:
<b>:return:<b>
200 - Email Sent - No Response
400 - Bad Request
403 - Invalid Token

69
lib/flask_autodoc/templates/autodoc_default.html
View file

@ -1,5 +1,10 @@
<html>
<head>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/materialize/0.96.1/css/materialize.min.css">
<!--Import jQuery before materialize.js-->
<script type="text/javascript" src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/materialize/0.96.1/js/materialize.min.js"></script>
<title>
{% if title is defined -%}
{{title}}
@ -8,15 +13,7 @@
{% endif -%}
</title>
<style>
* {
margin: 0;
padding: 0;
font-family: Verdana, "Helvetica Neue", Arial, Helvetica, Geneva, sans-serif;
}
body {
margin: 10px;
}
div.mapping {
margin: 20px 20px;
@ -45,6 +42,14 @@
</style>
</head>
<body>
<div class="navbar-fixed">
<nav>
<div class="nav-wrapper">
<a href="#!" class="brand-logo center">SE-Hub API Documentation</a>
</div>
</nav>
</div>
<h1>
{% if title is defined -%}
{{title}}
@ -54,14 +59,18 @@
</h1>
{% for doc in autodoc %}
<div class="mapping">
<a id="rule-{{doc.rule|urlencode}}" class="rule"><h2>{{doc.rule|escape}}</h2></a>
<ul class="methods">
<div style="margin-left: auto;margin-right: auto">
<div class="row" >
<div class="col s12 m6">
<div class="card blue-grey darken-1">
<div class="card-content white-text">
<span class="card-title">{{doc.rule|escape}}</span>
<ul class="methods">
{% for method in doc.methods -%}
<li class="method">{{method}}</li>
{% endfor %}
</ul>
<ul class="arguments">
<ul class="arguments">
{% for arg in doc.args %}
<li>
<span class="argument">{{arg}}</span>
@ -69,8 +78,42 @@
</li>
{% endfor %}
</ul>
<p class="docstring">{{doc.docstring|urlize|nl2br}}</p>
{{doc.docstring|safe}}
</div>
<div class="card-action">
<a href="#">This is a link</a>
<a href='#'>This is a link</a>
</div>
</div>
</div>
</div>
</div>
{% endfor %}
<footer class="page-footer">
<div class="container">
<div class="row">
<div class="col l6 s12">
<h5 class="white-text">Footer Content</h5>
<p class="grey-text text-lighten-4">You can use rows and columns here to organize your footer content.</p>
</div>
<div class="col l4 offset-l2 s12">
<h5 class="white-text">Links</h5>
<ul>
<li><a class="grey-text text-lighten-3" href="#!">Link 1</a></li>
<li><a class="grey-text text-lighten-3" href="#!">Link 2</a></li>
<li><a class="grey-text text-lighten-3" href="#!">Link 3</a></li>
<li><a class="grey-text text-lighten-3" href="#!">Link 4</a></li>
</ul>
</div>
</div>
</div>
<div class="footer-copyright">
<div class="container">
SE-Hub (c) 2015 Niptop Team
<a class="grey-text text-lighten-4 right" href="#!">More Links</a>
</div>
</div>
</footer>
</body>
</html>