Skip to content

Commit 3fe5ee7

Browse files
DeepPythonistDeepPythonist
committed
🚀 Deploy static documentation to root
- Copy Sphinx HTML output to root directory - Simplify GitHub Actions workflow - Use peaceiris/actions-gh-pages for deployment - All docs now available at root URL
1 parent 79acfe6 commit 3fe5ee7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+8439
-23
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 10 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
1-
name: Build and Deploy Documentation
1+
name: Deploy Documentation
22

33
on:
44
push:
55
branches: [ main ]
66

7-
permissions:
8-
contents: read
9-
pages: write
10-
id-token: write
11-
127
jobs:
13-
deploy:
14-
environment:
15-
name: github-pages
16-
url: ${{ steps.deployment.outputs.page_url }}
8+
build-and-deploy:
179
runs-on: ubuntu-latest
1810

1911
steps:
@@ -34,18 +26,13 @@ jobs:
3426
- name: Build documentation
3527
run: |
3628
cd docs
37-
sphinx-build -b html . _build/html
38-
# Copy index.html to root for GitHub Pages
39-
cp index.html _build/html/ || true
40-
41-
- name: Setup Pages
42-
uses: actions/configure-pages@v4
43-
44-
- name: Upload artifact
45-
uses: actions/upload-pages-artifact@v3
46-
with:
47-
path: docs/_build/html
29+
sphinx-build -b html . ../docs-built
30+
cd ..
31+
cp -r docs-built/* .
32+
rm -rf docs-built
4833
4934
- name: Deploy to GitHub Pages
50-
id: deployment
51-
uses: actions/deploy-pages@v4
35+
uses: peaceiris/actions-gh-pages@v3
36+
with:
37+
github_token: ${{ secrets.GITHUB_TOKEN }}
38+
publish_dir: .

‎_modules/index.html‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
<!DOCTYPE html>
2+
3+
<html lang="en" data-content_root="../">
4+
<head>
5+
<meta charset="utf-8" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Overview: module code &#8212; PyHetznerServer 1.2.4 documentation</title>
8+
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b76e3c8a" />
9+
<link rel="stylesheet" type="text/css" href="../_static/classic.css?v=def86cc0" />
10+
<link rel="stylesheet" type="text/css" href="../_static/custom.css?v=136f8262" />
11+
12+
<script src="../_static/documentation_options.js?v=928db92d"></script>
13+
<script src="../_static/doctools.js?v=9a2dae69"></script>
14+
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
15+
16+
<link rel="index" title="Index" href="../genindex.html" />
17+
<link rel="search" title="Search" href="../search.html" />
18+
</head><body>
19+
<div class="related" role="navigation" aria-label="related navigation">
20+
<h3>Navigation</h3>
21+
<ul>
22+
<li class="right" style="margin-right: 10px">
23+
<a href="../genindex.html" title="General Index"
24+
accesskey="I">index</a></li>
25+
<li class="nav-item nav-item-0"><a href="../index.html">PyHetznerServer 1.2.4 documentation</a> &#187;</li>
26+
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
27+
</ul>
28+
</div>
29+
30+
<div class="document">
31+
<div class="documentwrapper">
32+
<div class="bodywrapper">
33+
<div class="body" role="main">
34+
35+
<h1>All modules for which code is available</h1>
36+
<ul><li><a href="pyhetznerserver/client.html">pyhetznerserver.client</a></li>
37+
<li><a href="pyhetznerserver/exceptions.html">pyhetznerserver.exceptions</a></li>
38+
<li><a href="pyhetznerserver/managers/server_manager.html">pyhetznerserver.managers.server_manager</a></li>
39+
<li><a href="pyhetznerserver/models/base.html">pyhetznerserver.models.base</a></li>
40+
<li><a href="pyhetznerserver/models/nested.html">pyhetznerserver.models.nested</a></li>
41+
<li><a href="pyhetznerserver/models/server.html">pyhetznerserver.models.server</a></li>
42+
</ul>
43+
44+
<div class="clearer"></div>
45+
</div>
46+
</div>
47+
</div>
48+
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
49+
<div class="sphinxsidebarwrapper">
50+
<search id="searchbox" style="display: none" role="search">
51+
<h3 id="searchlabel">Quick search</h3>
52+
<div class="searchformwrapper">
53+
<form class="search" action="../search.html" method="get">
54+
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
55+
<input type="submit" value="Go" />
56+
</form>
57+
</div>
58+
</search>
59+
<script>document.getElementById('searchbox').style.display = "block"</script>
60+
</div>
61+
</div>
62+
<div class="clearer"></div>
63+
</div>
64+
<div class="related" role="navigation" aria-label="related navigation">
65+
<h3>Navigation</h3>
66+
<ul>
67+
<li class="right" style="margin-right: 10px">
68+
<a href="../genindex.html" title="General Index"
69+
>index</a></li>
70+
<li class="nav-item nav-item-0"><a href="../index.html">PyHetznerServer 1.2.4 documentation</a> &#187;</li>
71+
<li class="nav-item nav-item-this"><a href="">Overview: module code</a></li>
72+
</ul>
73+
</div>
74+
<div class="footer" role="contentinfo">
75+
&#169; Copyright 2024, Mohammad Rasol Esfandiari.
76+
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.3.7.
77+
</div>
78+
</body>
79+
</html>

0 commit comments

Comments
 (0)