Skip to content

Commit 5952562

Browse files
DeepPythonistDeepPythonist
committed
✨ Add comprehensive documentation with Sphinx
- 📚 Complete Sphinx documentation setup - 🌐 GitHub Pages workflow for automatic deployment - 📖 User guides: installation, quickstart, authentication - 🔧 API reference for all modules and classes - 📝 Contributing guide and changelog - 🎨 Custom CSS styling - ⚙️ ReadTheDocs configuration - 🚀 Ready for both GitHub Pages and ReadTheDocs deployment
1 parent fd6bd31 commit 5952562

File tree

15 files changed

+1055
-0
lines changed

15 files changed

+1055
-0
lines changed

‎.github/workflows/docs.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
name: Build and Deploy Documentation
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
permissions:
10+
contents: read
11+
pages: write
12+
id-token: write
13+
14+
concurrency:
15+
group: "pages"
16+
cancel-in-progress: false
17+
18+
jobs:
19+
build:
20+
runs-on: ubuntu-latest
21+
22+
steps:
23+
- uses: actions/checkout@v4
24+
25+
- name: Set up Python
26+
uses: actions/setup-python@v4
27+
with:
28+
python-version: '3.11'
29+
30+
- name: Install dependencies
31+
run: |
32+
python -m pip install --upgrade pip
33+
pip install sphinx sphinx-rtd-theme
34+
pip install -e .
35+
36+
- name: Build documentation
37+
run: |
38+
cd docs
39+
sphinx-build -b html . _build/html
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
48+
49+
deploy:
50+
environment:
51+
name: github-pages
52+
url: ${{ steps.deployment.outputs.page_url }}
53+
runs-on: ubuntu-latest
54+
needs: build
55+
if: github.ref == 'refs/heads/main'
56+
57+
steps:
58+
- name: Deploy to GitHub Pages
59+
id: deployment
60+
uses: actions/deploy-pages@v4

‎.readthedocs.yaml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# ReadTheDocs configuration file
2+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
3+
4+
version: 2
5+
6+
build:
7+
os: ubuntu-22.04
8+
tools:
9+
python: "3.11"
10+
11+
sphinx:
12+
configuration: docs/conf.py
13+
fail_on_warning: false
14+
15+
formats:
16+
- pdf
17+
- htmlzip
18+
19+
python:
20+
install:
21+
- requirements: docs/requirements.txt
22+
- method: pip
23+
path: .

‎docs/_static/custom.css‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/* Custom CSS for PyHetznerServer Documentation */
2+
3+
.wy-nav-content {
4+
max-width: 1200px;
5+
}
6+
7+
.highlight-python {
8+
border-left: 4px solid #2980B9;
9+
background-color: #f8f9fa;
10+
}
11+
12+
.admonition {
13+
border-radius: 5px;
14+
}
15+
16+
.admonition.note {
17+
border-left: 4px solid #2980B9;
18+
}
19+
20+
.admonition.warning {
21+
border-left: 4px solid #f39c12;
22+
}
23+
24+
.admonition.tip {
25+
border-left: 4px solid #27ae60;
26+
}
27+
28+
code {
29+
background-color: #f1f2f3;
30+
padding: 2px 4px;
31+
border-radius: 3px;
32+
}

‎docs/api/client.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
Client API
2+
==========
3+
4+
HetznerClient
5+
-------------
6+
7+
.. autoclass:: pyhetznerserver.HetznerClient
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
ServerManager
13+
-------------
14+
15+
.. autoclass:: pyhetznerserver.managers.server_manager.ServerManager
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

‎docs/api/exceptions.rst‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Exceptions API
2+
==============
3+
4+
Base Exception
5+
--------------
6+
7+
.. autoclass:: pyhetznerserver.HetznerAPIError
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
Specific Exceptions
13+
-------------------
14+
15+
Authentication Error
16+
~~~~~~~~~~~~~~~~~~~~
17+
18+
.. autoclass:: pyhetznerserver.AuthenticationError
19+
:members:
20+
:undoc-members:
21+
:show-inheritance:
22+
23+
Validation Error
24+
~~~~~~~~~~~~~~~~
25+
26+
.. autoclass:: pyhetznerserver.ValidationError
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Server Not Found Error
32+
~~~~~~~~~~~~~~~~~~~~~~
33+
34+
.. autoclass:: pyhetznerserver.ServerNotFoundError
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Rate Limit Error
40+
~~~~~~~~~~~~~~~~
41+
42+
.. autoclass:: pyhetznerserver.RateLimitError
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Conflict Error
48+
~~~~~~~~~~~~~~
49+
50+
.. autoclass:: pyhetznerserver.ConflictError
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
Resource Limit Error
56+
~~~~~~~~~~~~~~~~~~~~
57+
58+
.. autoclass:: pyhetznerserver.ResourceLimitError
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
Action Failed Error
64+
~~~~~~~~~~~~~~~~~~~
65+
66+
.. autoclass:: pyhetznerserver.ActionFailedError
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:

‎docs/api/models.rst‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Models API
2+
==========
3+
4+
Server Model
5+
------------
6+
7+
.. autoclass:: pyhetznerserver.Server
8+
:members:
9+
:undoc-members:
10+
:show-inheritance:
11+
12+
Base Model
13+
----------
14+
15+
.. autoclass:: pyhetznerserver.models.base.BaseObject
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
Nested Models
21+
-------------
22+
23+
ServerType
24+
~~~~~~~~~~
25+
26+
.. autoclass:: pyhetznerserver.models.nested.ServerType
27+
:members:
28+
:undoc-members:
29+
:show-inheritance:
30+
31+
Datacenter
32+
~~~~~~~~~~
33+
34+
.. autoclass:: pyhetznerserver.models.nested.Datacenter
35+
:members:
36+
:undoc-members:
37+
:show-inheritance:
38+
39+
Location
40+
~~~~~~~~
41+
42+
.. autoclass:: pyhetznerserver.models.nested.Location
43+
:members:
44+
:undoc-members:
45+
:show-inheritance:
46+
47+
Image
48+
~~~~~
49+
50+
.. autoclass:: pyhetznerserver.models.nested.Image
51+
:members:
52+
:undoc-members:
53+
:show-inheritance:
54+
55+
PublicNet
56+
~~~~~~~~~
57+
58+
.. autoclass:: pyhetznerserver.models.nested.PublicNet
59+
:members:
60+
:undoc-members:
61+
:show-inheritance:
62+
63+
PrivateNet
64+
~~~~~~~~~~
65+
66+
.. autoclass:: pyhetznerserver.models.nested.PrivateNet
67+
:members:
68+
:undoc-members:
69+
:show-inheritance:

0 commit comments

Comments
 (0)