CaZzzer/access-controller
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge branch 'feature/documentation' into 'develop'

Browse Source 
Feature/documentation

See merge request 2020-2021/online/s101/group-02/access_controller!95
This commit is contained in:
Кравченко Артем
2021-05-29 14:18:31 +00:00
parent e80c327d85 01ea7fec99
commit 73ceb174a6
5 changed files with 268 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
access_controller/urls.py
View File

@@ -39,6 +39,7 @@ urlpatterns = [
path('registration_failed/', registration_failed, name='registration_failed'),
path('control/', AdminPageView.as_view(), name='control'),
path('statistic/', statistic_page, name='statistic'),
]
# Django REST

13
docs/source/conf.py
View File

@@ -11,11 +11,15 @@
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sphinx.events
import sys
import inspect
import enchant
import django
sphinx.events.core_events['autodoc-process-signature'] = ''
sys.path.insert(0, os.path.abspath('../../'))
os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'access_controller.settings')
@@ -47,6 +51,8 @@ author = 'SHP S101, group 2'
release = 'v0.01'
# -- General configuration ---------------------------------------------------
def process_django_models(app, what, name, obj, options, lines):
@@ -112,8 +118,9 @@ def skip_queryset(app, what, name, obj, skip, options):
return skip
def fix_sig(app, what, name, obj, options, signature, return_annotation):
return "", ""
def process_signature(app, what: str, name: str, obj, options, signature, return_annotation):
if not callable(obj):
return
def setup(app):
@@ -121,7 +128,7 @@ def setup(app):
app.connect('autodoc-process-docstring', process_django_models)
app.connect('autodoc-skip-member', skip_queryset)
app.connect('autodoc-process-docstring', process_modules)
app.connect("autodoc-process-signature", fix_sig)
app.connect("autodoc-process-signature", process_signature)
# Add any Sphinx extension module names here, as strings. They can be

3
main/templates/base/menu.html
View File

@@ -59,6 +59,9 @@
class="btn btn-secondary"
{% endif %}
href="{{ registration_url }}">Зарегистрироваться</a>
{% url 'documentation' as documentation_url %}
<a class="btn btn-secondary"
href="{{ documentation_url }}">Документация</a>
</div>
{% endif %}
</nav>

252
main/templates/pages/documentation.html Normal file
View File

@@ -0,0 +1,252 @@
<!DOCTYPE html>
<html class="writer-html5" lang="ru" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Документация контроллера прав доступа &mdash; документация ZenDesk Access Controller v0.01</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/graphviz.css" type="text/css" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript" 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>
<script src="_static/translations.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="index" title="Алфавитный указатель" href="genindex.html" />
<link rel="search" title="Поиск" href="search.html" />
<link rel="next" title="Документация пользователя" href="overview.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home"> ZenDesk Access Controller
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Документация пользователя</a></li>
<li class="toctree-l1"><a class="reference internal" href="code.html">Документация разработчика</a></li>
<li class="toctree-l1"><a class="reference internal" href="readme.html">READ.me</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">Что необходимо доделать?</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">ZenDesk Access Controller</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Документация контроллера прав доступа</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="id1">
<h1>Документация контроллера прав доступа<a class="headerlink" href="#id1" title="Ссылка на этот заголовок"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Документация пользователя</a><ul>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id2">Управление правами доступа</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id3">Главная страница</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id4">Регистрация</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id5">Авторизация</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id6">Профиль</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id7">Запрос прав доступа</a></li>
<li class="toctree-l2"><a class="reference internal" href="overview.html#id8">Управление правами доступа администратором</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="code.html">Документация разработчика</a><ul>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.models">Models</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.forms">Forms</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.extra_func">Extra Functions</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.serializers">Serializers</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.views">Views</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.requester">Обработка тикетов</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.statistic_data">Обработка статистики</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.zendesk_admin">Функционал администратора Zendesk</a></li>
<li class="toctree-l2"><a class="reference internal" href="code.html#module-main.tests">Тесты</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="readme.html">READ.me</a></li>
<li class="toctree-l1"><a class="reference internal" href="todo.html">Что необходимо доделать?</a><ul>
<li class="toctree-l2"><a class="reference internal" href="todo.html#todos">TODOs</a></li>
</ul>
</li>
</ul>
</div>
</div>
<div class="section" id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Ссылка на этот заголовок"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="overview.html" class="btn btn-neutral float-right" title="Документация пользователя" accesskey="n" rel="next">Следующая <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
&#169; Copyright 2021, SHP S101, group 2.
</p>
</div>
Собрано при помощи <a href="https://www.sphinx-doc.org/">Sphinx</a> с использованием
<a href="https://github.com/readthedocs/sphinx_rtd_theme">темы,</a>
предоставленной <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

2
main/views.py
View File

@@ -444,3 +444,5 @@ def registration_failed(request: WSGIRequest) -> HttpResponse:
Функция отображения страницы "Регистрация закрыта".
"""
return render(request, 'pages/registration_failed.html')