0975b68334
Initial release: - Complete async API client (45+ endpoints) - Pydantic models for all responses - Two-step authentication - Comprehensive error handling - 92% test coverage - Gitea Actions CI/CD - Semantic release configured
780 lines
27 KiB
HTML
780 lines
27 KiB
HTML
|
||
<!doctype html>
|
||
<html lang="en" class="no-js">
|
||
<head>
|
||
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
|
||
<meta name="description" content="Unofficial Python client for Kwork.ru API">
|
||
|
||
|
||
|
||
<link rel="canonical" href="https://github.com/claw/kwork-api/GITEA_PAGES/">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="icon" href="../assets/images/favicon.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.6">
|
||
|
||
|
||
|
||
<title>Gitea Pages — Хостинг документации - Kwork API</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
||
|
||
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
||
|
||
|
||
|
||
|
||
|
||
</head>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
|
||
|
||
|
||
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
||
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
||
<label class="md-overlay" for="__drawer"></label>
|
||
<div data-md-component="skip">
|
||
|
||
|
||
<a href="#gitea-pages" class="md-skip">
|
||
Skip to content
|
||
</a>
|
||
|
||
</div>
|
||
<div data-md-component="announce">
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<header class="md-header" data-md-component="header">
|
||
<nav class="md-header__inner md-grid" aria-label="Header">
|
||
<a href=".." title="Kwork API" class="md-header__button md-logo" aria-label="Kwork API" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
|
||
|
||
</a>
|
||
<label class="md-header__button md-icon" for="__drawer">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
|
||
</label>
|
||
<div class="md-header__title" data-md-component="header-title">
|
||
<div class="md-header__ellipsis">
|
||
<div class="md-header__topic">
|
||
<span class="md-ellipsis">
|
||
Kwork API
|
||
</span>
|
||
</div>
|
||
<div class="md-header__topic" data-md-component="header-topic">
|
||
<span class="md-ellipsis">
|
||
|
||
Gitea Pages — Хостинг документации
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<form class="md-header__option" data-md-component="palette">
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6m0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4M7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg>
|
||
</label>
|
||
|
||
|
||
</form>
|
||
|
||
|
||
|
||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-header__button md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
</label>
|
||
<div class="md-search" data-md-component="search" role="dialog">
|
||
<label class="md-search__overlay" for="__search"></label>
|
||
<div class="md-search__inner" role="search">
|
||
<form class="md-search__form" name="search">
|
||
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
||
<label class="md-search__icon md-icon" for="__search">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
|
||
</label>
|
||
<nav class="md-search__options" aria-label="Search">
|
||
|
||
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
|
||
</button>
|
||
</nav>
|
||
|
||
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
||
|
||
</form>
|
||
<div class="md-search__output">
|
||
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
|
||
<div class="md-search-result" data-md-component="search-result">
|
||
<div class="md-search-result__meta">
|
||
Initializing search
|
||
</div>
|
||
<ol class="md-search-result__list" role="presentation"></ol>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-header__source">
|
||
<a href="https://github.com/claw/kwork-api" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
claw/kwork-api
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
</header>
|
||
|
||
<div class="md-container" data-md-component="container">
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
|
||
<div class="md-grid">
|
||
<ul class="md-tabs__list">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href=".." class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Home
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../api-reference/" class="md-tabs__link">
|
||
|
||
|
||
|
||
API Reference
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../examples.md" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Examples
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
|
||
<main class="md-main" data-md-component="main">
|
||
<div class="md-main__inner md-grid">
|
||
|
||
|
||
|
||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
||
<div class="md-sidebar__scrollwrap">
|
||
<div class="md-sidebar__inner">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
|
||
<label class="md-nav__title" for="__drawer">
|
||
<a href=".." title="Kwork API" class="md-nav__button md-logo" aria-label="Kwork API" data-md-component="logo">
|
||
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
|
||
|
||
</a>
|
||
Kwork API
|
||
</label>
|
||
|
||
<div class="md-nav__source">
|
||
<a href="https://github.com/claw/kwork-api" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
claw/kwork-api
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href=".." class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Home
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
|
||
|
||
|
||
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
API Reference
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
API Reference
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../api-reference/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Overview
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../api/client/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Client
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../api/models/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Models
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../api/errors/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Errors
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../examples.md" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Examples
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<h1 id="gitea-pages">Gitea Pages — Хостинг документации<a class="headerlink" href="#gitea-pages" title="Permanent link">¶</a></h1>
|
||
<h2 id="_1">📋 Обзор<a class="headerlink" href="#_1" title="Permanent link">¶</a></h2>
|
||
<p><strong>Gitea Pages</strong> — аналог GitHub Pages для хостинга статических сайтов напрямую из Gitea.</p>
|
||
<p><strong>URL документации:</strong> <code>https://git.much-data.ru/claw/kwork-api/</code></p>
|
||
<hr />
|
||
<h2 id="_2">🔧 НАСТРОЙКА<a class="headerlink" href="#_2" title="Permanent link">¶</a></h2>
|
||
<h3 id="1-pages"><strong>Шаг 1: Включить Pages в репозитории</strong><a class="headerlink" href="#1-pages" title="Permanent link">¶</a></h3>
|
||
<ol>
|
||
<li>Зайди в <a href="https://git.much-data.ru/claw/kwork-api">https://git.much-data.ru/claw/kwork-api</a></li>
|
||
<li><strong>Settings</strong> → <strong>Pages</strong></li>
|
||
<li>Включить <strong>Enable Pages</strong></li>
|
||
<li>Выбрать источник:</li>
|
||
<li><strong>Source:</strong> <code>gh-pages</code> branch</li>
|
||
<li><strong>Folder:</strong> <code>/ (root)</code></li>
|
||
<li><strong>Save</strong></li>
|
||
</ol>
|
||
<hr />
|
||
<h3 id="2-gitea-token"><strong>Шаг 2: Настроить Gitea Token</strong><a class="headerlink" href="#2-gitea-token" title="Permanent link">¶</a></h3>
|
||
<ol>
|
||
<li><a href="https://git.much-data.ru">https://git.much-data.ru</a> → Settings → Applications</li>
|
||
<li>Создать токен с правами:</li>
|
||
<li><code>write:repository</code></li>
|
||
<li><code>write:package</code></li>
|
||
<li>Скопировать токен</li>
|
||
<li>В репозитории: <strong>Settings</strong> → <strong>Secrets</strong></li>
|
||
<li>Добавить секрет: <code>GITEA_TOKEN</code> = твой токен</li>
|
||
</ol>
|
||
<hr />
|
||
<h3 id="3"><strong>Шаг 3: Первый деплой</strong><a class="headerlink" href="#3" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>/root/kwork-api
|
||
|
||
<span class="c1"># Собрать документацию</span>
|
||
uv<span class="w"> </span>run<span class="w"> </span>mkdocs<span class="w"> </span>build
|
||
|
||
<span class="c1"># Проверить что site/ создан</span>
|
||
ls<span class="w"> </span>-la<span class="w"> </span>site/
|
||
|
||
<span class="c1"># Закоммитить и запушить</span>
|
||
git<span class="w"> </span>add<span class="w"> </span>.
|
||
git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"docs: initial documentation"</span>
|
||
git<span class="w"> </span>push<span class="w"> </span>origin<span class="w"> </span>main
|
||
|
||
<span class="c1"># CI/CD автоматически задеплоит на gh-pages</span>
|
||
</code></pre></div>
|
||
<hr />
|
||
<h3 id="4"><strong>Шаг 4: Проверить</strong><a class="headerlink" href="#4" title="Permanent link">¶</a></h3>
|
||
<p>После успешного CI/CD:</p>
|
||
<p><strong>Документация доступна:</strong>
|
||
<div class="highlight"><pre><span></span><code>https://git.much-data.ru/claw/kwork-api/
|
||
</code></pre></div></p>
|
||
<p>Или если включён custom domain:
|
||
<div class="highlight"><pre><span></span><code>https://kwork-api.much-data.ru/
|
||
</code></pre></div></p>
|
||
<hr />
|
||
<h2 id="_3">🔄 АВТОМАТИЧЕСКИЙ ДЕПЛОЙ<a class="headerlink" href="#_3" title="Permanent link">¶</a></h2>
|
||
<p><strong>Workflow срабатывает при:</strong>
|
||
- ✅ Push в <code>main</code> ветку
|
||
- ✅ Создании тега релиза</p>
|
||
<p><strong>Что делает:</strong>
|
||
1. Собирает MkDocs документацию
|
||
2. Пушит в <code>gh-pages</code> ветку
|
||
3. Gitea Pages автоматически обновляет сайт</p>
|
||
<hr />
|
||
<h2 id="custom-domain">🌐 CUSTOM DOMAIN (опционально)<a class="headerlink" href="#custom-domain" title="Permanent link">¶</a></h2>
|
||
<h3 id="dns"><strong>DNS настройка:</strong><a class="headerlink" href="#dns" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code># В панели управления доменом much-data.ru
|
||
|
||
# CNAME запись:
|
||
kwork-api CNAME git.much-data.ru
|
||
|
||
# Или A запись:
|
||
kwork-api A 5.188.26.192
|
||
</code></pre></div>
|
||
<h3 id="gitea-pages_1"><strong>В Gitea Pages:</strong><a class="headerlink" href="#gitea-pages_1" title="Permanent link">¶</a></h3>
|
||
<ol>
|
||
<li><strong>Settings</strong> → <strong>Pages</strong></li>
|
||
<li><strong>Custom Domain:</strong> <code>kwork-api.much-data.ru</code></li>
|
||
<li><strong>Save</strong></li>
|
||
</ol>
|
||
<h3 id="cname"><strong>Создать CNAME файл:</strong><a class="headerlink" href="#cname" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># В корне проекта (не в site/)</span>
|
||
<span class="nb">echo</span><span class="w"> </span><span class="s2">"kwork-api.much-data.ru"</span><span class="w"> </span>><span class="w"> </span>static/CNAME
|
||
git<span class="w"> </span>add<span class="w"> </span>static/CNAME
|
||
git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">"docs: add custom domain"</span>
|
||
git<span class="w"> </span>push
|
||
</code></pre></div>
|
||
<hr />
|
||
<h2 id="_4">📊 СТРУКТУРА ВЕТКИ<a class="headerlink" href="#_4" title="Permanent link">¶</a></h2>
|
||
<div class="highlight"><pre><span></span><code>main (исходный код)
|
||
├── src/
|
||
├── docs/
|
||
├── mkdocs.yml
|
||
└── .github/workflows/ci.yml
|
||
|
||
gh-pages (автоматически, только сайт)
|
||
├── index.html
|
||
├── api-reference/
|
||
├── search/
|
||
└── ...
|
||
</code></pre></div>
|
||
<hr />
|
||
<h2 id="troubleshooting">🔍 TROUBLESHOOTING<a class="headerlink" href="#troubleshooting" title="Permanent link">¶</a></h2>
|
||
<h3 id="pages"><strong>Pages не включаются:</strong><a class="headerlink" href="#pages" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Проверить что Gitea версия >= 1.19</span>
|
||
<span class="c1"># Админ должен включить Pages в настройках сервера</span>
|
||
</code></pre></div>
|
||
<h3 id="cicd"><strong>CI/CD ошибка деплоя:</strong><a class="headerlink" href="#cicd" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Проверить токен</span>
|
||
<span class="c1"># Проверить права токена (write:repository)</span>
|
||
<span class="c1"># Проверить что gh-pages ветка существует</span>
|
||
</code></pre></div>
|
||
<h3 id="404"><strong>404 на странице:</strong><a class="headerlink" href="#404" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Подождать 1-2 минуты (Gitea обрабатывает)</span>
|
||
<span class="c1"># Проверить что site/ не пустой</span>
|
||
<span class="c1"># Проверить workflow логи</span>
|
||
</code></pre></div>
|
||
<hr />
|
||
<h2 id="_5">📋 ЧЕКЛИСТ<a class="headerlink" href="#_5" title="Permanent link">¶</a></h2>
|
||
<ul class="task-list">
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Включить Pages в настройках репозитория</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Создать Gitea Token</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Добавить токен в Secrets (<code>GITEA_TOKEN</code>)</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Запушить изменения в main</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Дождаться CI/CD</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Проверить <a href="https://git.much-data.ru/claw/kwork-api/">https://git.much-data.ru/claw/kwork-api/</a></li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> (Опционально) Настроить custom domain</li>
|
||
</ul>
|
||
<hr />
|
||
<h2 id="_6">🎯 АЛЬТЕРНАТИВЫ<a class="headerlink" href="#_6" title="Permanent link">¶</a></h2>
|
||
<p>Если Gitea Pages не работает:</p>
|
||
<h3 id="1-netlify"><strong>1. Netlify (бесплатно)</strong><a class="headerlink" href="#1-netlify" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Подключить репозиторий</span>
|
||
<span class="c1"># Build command: uv run mkdocs build</span>
|
||
<span class="c1"># Publish directory: site/</span>
|
||
</code></pre></div>
|
||
<h3 id="2-vercel"><strong>2. Vercel (бесплатно)</strong><a class="headerlink" href="#2-vercel" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Аналогично Netlify</span>
|
||
<span class="c1"># Автоматический деплой из Git</span>
|
||
</code></pre></div>
|
||
<h3 id="3-cloudflare-pages"><strong>3. Cloudflare Pages (бесплатно)</strong><a class="headerlink" href="#3-cloudflare-pages" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Быстрый CDN</span>
|
||
<span class="c1"># Автоматический HTTPS</span>
|
||
</code></pre></div>
|
||
<h3 id="4-nginx"><strong>4. Своё сервер (nginx)</strong><a class="headerlink" href="#4-nginx" title="Permanent link">¶</a></h3>
|
||
<div class="highlight"><pre><span></span><code><span class="c1"># Скопировать site/ на сервер</span>
|
||
<span class="c1"># Настроить nginx на /var/www/kwork-api-docs/</span>
|
||
</code></pre></div>
|
||
<hr />
|
||
<h2 id="_7">📞 ССЫЛКИ<a class="headerlink" href="#_7" title="Permanent link">¶</a></h2>
|
||
<ul>
|
||
<li><a href="https://docs.gitea.com/usage/pages">Gitea Pages Documentation</a></li>
|
||
<li><a href="https://www.mkdocs.org/">MkDocs Documentation</a></li>
|
||
<li><a href="https://docs.gitea.com/usage/actions">Gitea Actions</a></li>
|
||
</ul>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||
</div>
|
||
|
||
</main>
|
||
|
||
<footer class="md-footer">
|
||
|
||
<div class="md-footer-meta md-typeset">
|
||
<div class="md-footer-meta__inner md-grid">
|
||
<div class="md-copyright">
|
||
|
||
|
||
Made with
|
||
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
|
||
Material for MkDocs
|
||
</a>
|
||
|
||
</div>
|
||
|
||
</div>
|
||
</div>
|
||
</footer>
|
||
|
||
</div>
|
||
<div class="md-dialog" data-md-component="dialog">
|
||
<div class="md-dialog__inner md-typeset"></div>
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.tabs", "navigation.sections", "toc.integrate", "search.suggest", "search.highlight"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
|
||
|
||
|
||
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |