public/kontur-focus-lib
1
0
Fork 0
Code Issues Pull Requests Packages Releases 12 Wiki Activity

Generated docs

Browse Source
This commit is contained in:
Ilya Sapunov
2025-07-22 18:28:16 +03:00
parent f229c309c4
commit 9a9ffda4ac
83 changed files with 8364 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

136
docs/out/html/setup.html Normal file
View File

@@ -0,0 +1,136 @@
<!DOCTYPE html>
<html class="writer-html5" lang="ru" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Установка &mdash; документация Kontur Focus Library 0.1.0</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=6ff560e8"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/translations.js?v=cd1d70c9"></script>
<script 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="focus.html" />
<link rel="prev" title="Kontur Focus Library documentation" href="index.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="index.html" class="icon icon-home">
Kontur Focus Library
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Поиск в документации" aria-label="Поиск в документации" />
<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="Меню навигации">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Установка</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#pip">Установка через pip</a></li>
<li class="toctree-l2"><a class="reference internal" href="#requirements-txt">Использование requirements.txt</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="focus.html">Фокус</a></li>
<li class="toctree-l1"><a class="reference internal" href="focus-compliance.html">Фокус.Комплаенс</a></li>
<li class="toctree-l1"><a class="reference internal" href="open-api.html">Open API specification</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Меню навигации для мобильных устройств" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Kontur Focus Library</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Навигация по страницам">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Установка</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/setup.rst.txt" rel="nofollow"> Просмотреть исходный код страницы</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="id1">
<h1>Установка<a class="headerlink" href="#id1" title="Ссылка на этот заголовок"></a></h1>
<p>Для установки необходимо иметь доступ в корпоративный <a class="reference external" href="https://git.selectel.org">Gitlab</a>, чтобы получить доступ к Registry PyPi.</p>
<section id="pip">
<h2>Установка через pip<a class="headerlink" href="#pip" title="Ссылка на этот заголовок"></a></h2>
<p>Выполните <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">kontur-focus</span> <span class="pre">--index-url</span> <span class="pre">https://__token__:&lt;your_personal_token&gt;&#64;git.selectel.org/api/v4/projects/6350/packages/pypi/simple</span></code></p>
<p>Где <cite>&lt;your_personal_token&gt;</cite> - <a class="reference external" href="https://git.selectel.org/help/user/profile/personal_access_tokens">персональный токен</a> доступа Gitlab.</p>
</section>
<section id="requirements-txt">
<h2>Использование requirements.txt<a class="headerlink" href="#requirements-txt" title="Ссылка на этот заголовок"></a></h2>
<p>Перед использованием необходимо настроить Registry.</p>
<p>Создайте файл <cite>.pypirc</cite> в папке пользователя и добавьте параметры репозитория:</p>
<div class="highlight-console notranslate"><div class="highlight"><pre><span></span><span class="go">[gitlab]</span>
<span class="go">repository = https://git.selectel.org/api/v4/projects/6350/packages/pypi</span>
<span class="go">username = __token__</span>
<span class="go">password = &lt;your personal access token&gt;</span>
</pre></div>
</div>
<p>Более подробно <a class="reference external" href="https://git.selectel.org/help/user/packages/pypi_repository/index">тут</a>.</p>
<p>После выполните <code class="docutils literal notranslate"><span class="pre">pip</span> <span class="pre">install</span> <span class="pre">-r</span> <span class="pre">requirements.txt</span></code></p>
</section>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Нижняя область">
<a href="index.html" class="btn btn-neutral float-left" title="Kontur Focus Library documentation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Предыдущая</a>
<a href="focus.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; Авторские права 2025, Ilya Sapunov. </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>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>