Improved documentation

This commit is contained in:
Syrus Akbary 2016-09-15 00:38:53 -07:00
parent 78ff67eb13
commit 84c8711f79
2 changed files with 50 additions and 1 deletions

47
docs/_templates/layout.html vendored Normal file
View File

@ -0,0 +1,47 @@
<!DOCTYPE html>
<html><head><meta charset="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><meta name="viewport" content="width=device-width, initial-scale=1.0 maximum-scale=1.0"/><title></title><link rel="shortcut icon" href="/favicon.png"/><link href="https://fonts.googleapis.com/css?family=Open+Sans:300,400,600,700" rel="stylesheet" type="text/css"/><link href="/_static/app.css" rel="stylesheet" type="text/css"/></head><body class="body--docs"><div id="react-mount"><div class="documentation-page" data-reactroot="" data-reactid="1" data-react-checksum="-1266550345"><div data-reactid="2"><div class="bm-overlay" style="position:fixed;z-index:1;width:100%;height:100%;background:rgba(0, 0, 0, 0.3);opacity:0;transform:translate3d(-100%, 0, 0);transition:opacity 0.3s, transform 0s 0.3s;" data-reactid="3"></div><div id="" class="bm-menu-wrap" style="position:fixed;right:0;z-index:2;width:200px;height:100%;transform:translate3d(220px, 0, 0);transition:transform 0.4s cubic-bezier(0.7, 0, 0.3, 1);" data-reactid="4"><div class="bm-menu" style="height:100%;box-sizing:border-box;" data-reactid="5"><nav class="bm-item-list" style="height:100%;" data-reactid="6"><span style="display:block;outline:none;transform:translate3d(0, 500px, 0);transition:transform 0s 0.2s cubic-bezier(0.7, 0, 0.3, 1);" data-reactid="7"><a href="/playground/" data-reactid="8">Try it out</a></span><span style="display:block;outline:none;transform:translate3d(0, 1000px, 0);transition:transform 0s 0.2s cubic-bezier(0.7, 0, 0.3, 1);" data-reactid="9"><a class="active" href="/docs/quickstart/" data-reactid="10">Documentation</a></span><span style="display:block;outline:none;transform:translate3d(0, 1500px, 0);transition:transform 0s 0.2s cubic-bezier(0.7, 0, 0.3, 1);" data-reactid="11"><a href="/blog/" data-reactid="12">Blog</a></span><a href="https://github.com/graphql-python/graphene/" style="display:block;outline:none;transform:translate3d(0, 2000px, 0);transition:transform 0s 0.2s cubic-bezier(0.7, 0, 0.3, 1);" data-reactid="13">Github</a></nav></div><div data-reactid="14"><div data-reactid="15"><span class="bm-cross" style="position:absolute;width:3px;height:14px;top:14px;right:18px;cursor:pointer;transform:rotate(45deg);z-index:1;" data-reactid="16"></span><span class="bm-cross" style="position:absolute;width:3px;height:14px;top:14px;right:18px;cursor:pointer;transform:rotate(-45deg);z-index:1;" data-reactid="17"></span><button style="width:14px;height:14px;position:absolute;right:13px;top:14px;padding:0;overflow:hidden;text-indent:14px;font-size:14px;border:none;background:transparent;color:transparent;outline:none;z-index:1;" data-reactid="18">Close Menu</button></div></div></div><div class="bm-burger-button" style="z-index:1;" data-reactid="19"><span data-reactid="20"><span class="bm-burger-bars" style="position:absolute;height:20%;left:0;right:0;top:0%;opacity:1;" data-reactid="21"></span><span class="bm-burger-bars" style="position:absolute;height:20%;left:0;right:0;top:40%;opacity:1;" data-reactid="22"></span><span class="bm-burger-bars" style="position:absolute;height:20%;left:0;right:0;top:80%;opacity:1;" data-reactid="23"></span></span><button style="position:absolute;left:0;right:0;top:0;bottom:0;margin:0;padding:0;border:none;font-size:14px;color:transparent;background:transparent;outline:none;" data-reactid="24">Open Menu</button></div></div><header class="header" data-reactid="25"><div class="header-wrapper" data-reactid="26"><a class="header-logo" href="/" data-reactid="27"><span class="graphene-logo" data-reactid="28"><span data-reactid="29"><svg width="100%" height="100%" viewBox="0 0 100 100" xmlns="http://www.w3.org/2000/svg" class="logo"><g fill="none" fill-rule="evenodd"><path class="logo-path" d="M49.17 10.915L15.415 30.29l.058 39.252 34.633 20.082 33.345-18.95-.023-39.79-34.185 19.238" stroke="white" stroke-width="4.987"/>
<g transform="translate(41.5 3)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
<g transform="translate(8 22.482)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
<g transform="translate(8 62.33)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
<g transform="translate(42.382 81.813)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
<g transform="translate(75.882 62.33)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
<g transform="translate(75.882 22.482)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
<g transform="translate(42.382 41.964)"><ellipse cx="7.934" cy="7.97" rx="7.934" ry="7.97" fill="white"/></g>
</g>
</svg>
</span><!-- react-text: 30 -->Graphene<!-- /react-text --></span></a><nav class="header-nav" data-reactid="31"><a href="/playground/" data-reactid="32">Try it live</a><a class="active" href="/docs/quickstart/" data-reactid="33">Documentation</a><a href="/blog/" data-reactid="34">Blog</a><a class="github-icon" href="https://github.com/graphql-python/graphene/" data-reactid="35">Github</a></nav></div></header><div data-reactid="36"><div data-reactid="37">
<div class="document">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
{{ toctree() }}
</div>
</div>
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
{{ body }}
<div class="go-buttons">
{% if prev %}
<a href="{{ prev.link|e }}" class="go-previous">Previous: {{ prev.title|striptags|e }}</a>
{% endif %}
{% if next %}
<a href="{{ next.link|e }}" class="go-next">Next: {{ next.title|striptags|e }}</a>
{% endif %}
</div>
</div>
</div>
</div>
</div>
<a href="https://{{ github_host|default("github.com") }}/{{ github_user }}/{{ github_repo }}/blob/{{ github_version }}{{ conf_py_path }}{{ pagename }}{{ suffix }}" class="improve-document-link">Edit page</a>
</div><div class="footer" data-reactid="38"></div></div></div></body></html>

View File

@ -2,7 +2,9 @@ Mutations
=========
Most APIs dont just allow you to read data, they also allow you to
write. In GraphQL, this is done using mutations. Just like queries,
write.
In GraphQL, this is done using mutations. Just like queries,
Relay puts some additional requirements on mutations, but Graphene
nicely manages that for you. All you need to do is make your mutation a
subclass of ``relay.ClientIDMutation``.