warning + workflows

Author: ViktoriaNov

.github/workflows/docs.yml

@@ -1,31 +1,90 @@
-name: Deploy Sphinx docs to GitHub Pages
+name: Build & Deploy Sphinx Docs
 
 on:
   push:
-    branches: [ main ]
+    branches:
+      - page        # тестовая ветка для preview
+      - main        # production deploy
+  pull_request:
+    branches:
+      - main        # проверка перед merge
 
 permissions:
   contents: read
   pages: write
   id-token: write
 
 jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          pip install -r docs/requirements.txt
+
+      - name: Build Sphinx docs
+        run: |
+          cd docs
+          python -m sphinx -b html . _build/html
+
+      - name: Upload artifact (HTML for preview)
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs-html
+          path: docs/_build/html
+
+  preview:
+    if: github.ref == 'refs/heads/page'
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download built docs
+        uses: actions/download-artifact@v4
+        with:
+          name: docs-html
+          path: ./docs/_build/html
+
+      - name: Configure GitHub Pages preview
+        uses: actions/configure-pages@v4
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_build/html
+
+      - name: Deploy preview
+        id: deployment
+        uses: actions/deploy-pages@v4
+
   deploy:
+    if: github.ref == 'refs/heads/main'
+    needs: build
+    runs-on: ubuntu-latest
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+      - name: Download built docs
+        uses: actions/download-artifact@v4
+        with:
+          name: docs-html
+          path: ./docs/_build/html
 
-    - name: Setup Pages
-      uses: actions/configure-pages@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
 
-    - name: Upload artifact
-      uses: actions/upload-pages-artifact@v3
-      with:
-        path: ./docs/_build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/_build/html
 
-    - name: Deploy to GitHub Pages
-      id: deployment
-      uses: actions/deploy-pages@v4
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/_build/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: f0951d5432eef154e25aad70f2f8dd99
+config: a32d920eac3b9747d56b69f1dc98ea4c
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/.doctrees/environment.pickle

@@ -1,2 +1 @@
-.. raw:: html
-   :file: front_page.html
+.. This file exists only because Sphinx requires index.rst

docs/_build/html/.doctrees/index.doctree

@@ -211,7 +211,7 @@ table.modindextable td {
 /* -- general body styles --------------------------------------------------- */
 
 div.body {
-    min-width: inherit;
+    min-width: 360px;
     max-width: 800px;
 }
 

docs/_build/html/_sources/index.rst.txt

@@ -4,81 +4,4 @@ span.linenos { color: inherit; background-color: transparent; padding-left: 5px;
 td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
 .highlight .hll { background-color: #ffffcc }
-.highlight { background: #f8f8f8; }
-.highlight .c { color: #8F5902; font-style: italic } /* Comment */
-.highlight .err { color: #A40000; border: 1px solid #EF2929 } /* Error */
-.highlight .g { color: #000 } /* Generic */
-.highlight .k { color: #004461; font-weight: bold } /* Keyword */
-.highlight .l { color: #000 } /* Literal */
-.highlight .n { color: #000 } /* Name */
-.highlight .o { color: #582800 } /* Operator */
-.highlight .x { color: #000 } /* Other */
-.highlight .p { color: #000; font-weight: bold } /* Punctuation */
-.highlight .ch { color: #8F5902; font-style: italic } /* Comment.Hashbang */
-.highlight .cm { color: #8F5902; font-style: italic } /* Comment.Multiline */
-.highlight .cp { color: #8F5902 } /* Comment.Preproc */
-.highlight .cpf { color: #8F5902; font-style: italic } /* Comment.PreprocFile */
-.highlight .c1 { color: #8F5902; font-style: italic } /* Comment.Single */
-.highlight .cs { color: #8F5902; font-style: italic } /* Comment.Special */
-.highlight .gd { color: #A40000 } /* Generic.Deleted */
-.highlight .ge { color: #000; font-style: italic } /* Generic.Emph */
-.highlight .ges { color: #000 } /* Generic.EmphStrong */
-.highlight .gr { color: #EF2929 } /* Generic.Error */
-.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
-.highlight .gi { color: #00A000 } /* Generic.Inserted */
-.highlight .go { color: #888 } /* Generic.Output */
-.highlight .gp { color: #745334 } /* Generic.Prompt */
-.highlight .gs { color: #000; font-weight: bold } /* Generic.Strong */
-.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.highlight .gt { color: #A40000; font-weight: bold } /* Generic.Traceback */
-.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
-.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
-.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
-.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
-.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
-.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
-.highlight .ld { color: #000 } /* Literal.Date */
-.highlight .m { color: #900 } /* Literal.Number */
-.highlight .s { color: #4E9A06 } /* Literal.String */
-.highlight .na { color: #C4A000 } /* Name.Attribute */
-.highlight .nb { color: #004461 } /* Name.Builtin */
-.highlight .nc { color: #000 } /* Name.Class */
-.highlight .no { color: #000 } /* Name.Constant */
-.highlight .nd { color: #888 } /* Name.Decorator */
-.highlight .ni { color: #CE5C00 } /* Name.Entity */
-.highlight .ne { color: #C00; font-weight: bold } /* Name.Exception */
-.highlight .nf { color: #000 } /* Name.Function */
-.highlight .nl { color: #F57900 } /* Name.Label */
-.highlight .nn { color: #000 } /* Name.Namespace */
-.highlight .nx { color: #000 } /* Name.Other */
-.highlight .py { color: #000 } /* Name.Property */
-.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
-.highlight .nv { color: #000 } /* Name.Variable */
-.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
-.highlight .pm { color: #000; font-weight: bold } /* Punctuation.Marker */
-.highlight .w { color: #F8F8F8 } /* Text.Whitespace */
-.highlight .mb { color: #900 } /* Literal.Number.Bin */
-.highlight .mf { color: #900 } /* Literal.Number.Float */
-.highlight .mh { color: #900 } /* Literal.Number.Hex */
-.highlight .mi { color: #900 } /* Literal.Number.Integer */
-.highlight .mo { color: #900 } /* Literal.Number.Oct */
-.highlight .sa { color: #4E9A06 } /* Literal.String.Affix */
-.highlight .sb { color: #4E9A06 } /* Literal.String.Backtick */
-.highlight .sc { color: #4E9A06 } /* Literal.String.Char */
-.highlight .dl { color: #4E9A06 } /* Literal.String.Delimiter */
-.highlight .sd { color: #8F5902; font-style: italic } /* Literal.String.Doc */
-.highlight .s2 { color: #4E9A06 } /* Literal.String.Double */
-.highlight .se { color: #4E9A06 } /* Literal.String.Escape */
-.highlight .sh { color: #4E9A06 } /* Literal.String.Heredoc */
-.highlight .si { color: #4E9A06 } /* Literal.String.Interpol */
-.highlight .sx { color: #4E9A06 } /* Literal.String.Other */
-.highlight .sr { color: #4E9A06 } /* Literal.String.Regex */
-.highlight .s1 { color: #4E9A06 } /* Literal.String.Single */
-.highlight .ss { color: #4E9A06 } /* Literal.String.Symbol */
-.highlight .bp { color: #3465A4 } /* Name.Builtin.Pseudo */
-.highlight .fm { color: #000 } /* Name.Function.Magic */
-.highlight .vc { color: #000 } /* Name.Variable.Class */
-.highlight .vg { color: #000 } /* Name.Variable.Global */
-.highlight .vi { color: #000 } /* Name.Variable.Instance */
-.highlight .vm { color: #000 } /* Name.Variable.Magic */
-.highlight .il { color: #900 } /* Literal.Number.Integer.Long */
+.highlight { background: #ffffff; }

docs/_build/html/_static/basic.css

@@ -5,31 +5,30 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
     <title>Index &#8212; LLMSQL 0.2.0 documentation</title>
-    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=5ecbeea2" />
-    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=b08954a9" />
-    <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=27fed22d" />
-    <link rel="stylesheet" type="text/css" href="_static/styles/front_page.css" />
+    <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
+    <link rel="stylesheet" type="text/css" href="_static/basic.css?v=29da98fa" />
+    <link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=46e78057" />
     <script src="_static/documentation_options.js?v=938c9ccc"></script>
     <script src="_static/doctools.js?v=9bcbadda"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
-    <script src="_static/scripts/front_page.js"></script>
+    <script src="_static/scripts/front_page.js?v=a59558f4"></script>
     <link rel="index" title="Index" href="#" />
-    <link rel="search" title="Search" href="search.html" />
-   
-  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
-  
-
-  
-  
-
+    <link rel="search" title="Search" href="search.html" /> 
   </head><body>
-  
+    <div class="related" role="navigation" aria-label="Related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="#" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="nav-item nav-item-0"><a href="index.html">LLMSQL 0.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
+      </ul>
+    </div>  
 
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-          
-
           <div class="body" role="main">
 
 
@@ -40,62 +39,39 @@ <h1 id="index">Index</h1>
 </div>
 
 
+            <div class="clearer"></div>
           </div>
-          
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="Main">
         <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="index.html">LLMSQL</a></h1>
-
-
-
-
-
-
-
-
-
 <search 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" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" placeholder="Search"/>
+      <input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
       <input type="submit" value="Go" />
     </form>
     </div>
 </search>
-<script>document.getElementById('searchbox').style.display = "block"</script><h3>Navigation</h3>
-
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="index.html">Documentation overview</a><ul>
-  </ul></li>
-</ul>
-</div>
-
-
-
-
-
-
-
-
+<script>document.getElementById('searchbox').style.display = "block"</script>
         </div>
       </div>
       <div class="clearer"></div>
     </div>
-    <div class="footer">
-      &#169;2025, Dzmitry Pihulski.
-      
-      |
-      Powered by <a href="https://www.sphinx-doc.org/">Sphinx 8.2.3</a>
-      &amp; <a href="https://alabaster.readthedocs.io">Alabaster 1.0.0</a>
-      
+    <div class="related" role="navigation" aria-label="Related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="#" title="General Index"
+             >index</a></li>
+        <li class="nav-item nav-item-0"><a href="index.html">LLMSQL 0.2.0 documentation</a> &#187;</li>
+        <li class="nav-item nav-item-this"><a href="">Index</a></li> 
+      </ul>
+    </div>
+    <div class="footer" role="contentinfo">
+    &#169; Copyright 2025, Dzmitry Pihulski.
+      Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
     </div>
-
-    
-
-    
   </body>
 </html>