1
Fork 0
mirror of https://github.com/pds-nest/nest.git synced 2024-11-25 14:34:19 +00:00
pds-2021-g2-nest/code/backend/docs/_build/html/nest_backend.routes.html
Lorenzo Balugani 6d512c3abe Add sphinx docs
2021-04-26 18:14:53 +02:00

157 lines
No EOL
7.2 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>nest_backend.routes package &#8212; N.E.S.T. Backend documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="nest_backend.routes.repository package" href="nest_backend.routes.repository.html" />
<link rel="prev" title="nest_backend.database.tables package" href="nest_backend.database.tables.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="nest-backend-routes-package">
<h1>nest_backend.routes package<a class="headerlink" href="#nest-backend-routes-package" title="Permalink to this headline"></a></h1>
<div class="section" id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="nest_backend.routes.repository.html">nest_backend.routes.repository package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_add_condition">nest_backend.routes.repository.repository_add_condition module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_create">nest_backend.routes.repository.repository_create module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_edit">nest_backend.routes.repository.repository_edit module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository.repository_list">nest_backend.routes.repository.repository_list module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.repository.html#module-nest_backend.routes.repository">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="nest_backend.routes.users.html">nest_backend.routes.users package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.login">nest_backend.routes.users.login module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.user_create">nest_backend.routes.users.user_create module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users.user_delete">nest_backend.routes.users.user_delete module</a></li>
<li class="toctree-l2"><a class="reference internal" href="nest_backend.routes.users.html#module-nest_backend.routes.users">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Permalink to this headline"></a></h2>
</div>
<div class="section" id="module-nest_backend.routes.doa">
<span id="nest-backend-routes-doa-module"></span><h2>nest_backend.routes.doa module<a class="headerlink" href="#module-nest_backend.routes.doa" title="Permalink to this headline"></a></h2>
<p>Page that displays a message if the server is on</p>
<dl class="py function">
<dt id="nest_backend.routes.doa.page_doa">
<code class="sig-prename descclassname"><span class="pre">nest_backend.routes.doa.</span></code><code class="sig-name descname"><span class="pre">page_doa</span></code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#nest_backend.routes.doa.page_doa" title="Permalink to this definition"></a></dt>
<dd><p>Dead or Alive page. If a client sees this, the server is probably fine.
:return: A friendly and calming message, that makes you happy that the server is not on fire.</p>
</dd></dl>
</div>
<div class="section" id="module-nest_backend.routes">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-nest_backend.routes" title="Permalink to this headline"></a></h2>
<p>This module imports all the routes that return something to the frontend.</p>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">N.E.S.T. Backend</a></h1>
<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">backend</a><ul class="current">
<li class="toctree-l2 current"><a class="reference internal" href="nest_backend.html">nest_backend package</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
<li><a href="modules.html">backend</a><ul>
<li><a href="nest_backend.html">nest_backend package</a><ul>
<li>Previous: <a href="nest_backend.database.tables.html" title="previous chapter">nest_backend.database.tables package</a></li>
<li>Next: <a href="nest_backend.routes.repository.html" title="next chapter">nest_backend.routes.repository package</a></li>
</ul></li>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, Gruppo 2.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 3.5.4</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/nest_backend.routes.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>