Skip to content

Commit c0a12a3

Browse files
committed
Move mkdocs to root
1 parent c87b595 commit c0a12a3

2 files changed

Lines changed: 82 additions & 3 deletions

File tree

.github/workflows/deploy-docs.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,10 @@ jobs:
3232
python-version: '3.11'
3333

3434
- name: Install dependencies
35-
working-directory: ./docs
3635
run: |
37-
pip install -r requirements.txt
36+
pip install -r docs/requirements.txt
3837
3938
- name: Build MkDocs
40-
working-directory: ./docs
4139
run: mkdocs build
4240

4341
- name: Upload artifact

mkdocs.yml

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
site_name: Zero
2+
site_description: Zero - A simple Python RPC framework to build fast and high performance microservices
3+
site_url: https://ananto30.github.io/zero/
4+
repo_url: https://github.com/Ananto30/zero
5+
repo_name: Ananto30/zero
6+
edit_uri: edit/main/docs/
7+
8+
theme:
9+
name: material
10+
logo: https://ananto30.github.io/i/1200xCL_TP.png
11+
favicon: https://ananto30.github.io/i/1200xCL_TP.png
12+
palette:
13+
- scheme: default
14+
primary: black
15+
accent: grey
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
- scheme: slate
20+
primary: black
21+
accent: grey
22+
toggle:
23+
icon: material/brightness-4
24+
name: Switch to light mode
25+
features:
26+
- navigation.instant
27+
- navigation.tracking
28+
- navigation.top
29+
- search.suggest
30+
- search.highlight
31+
- content.tabs.link
32+
- content.code.copy
33+
34+
nav:
35+
- Home: index.md
36+
- Getting Started: getting-started.md
37+
- Guides:
38+
- Installation: guides/installation.md
39+
- Basic Usage: guides/basic-usage.md
40+
- Error Handling: guides/error-handling.md
41+
- Serialization/Encoding: guides/serialization.md
42+
- TCP Protocol: guides/tcp-protocol.md
43+
- Code Generation: guides/code-generation.md
44+
- Async/Await: guides/async-await.md
45+
- Examples:
46+
- Basic Echo: examples/basic-echo.md
47+
- Order Management: examples/order-management.md
48+
- API Reference:
49+
- Server: api/server.md
50+
- Client: api/client.md
51+
- Async Client: api/async-client.md
52+
- Benchmarks: benchmarks.md
53+
- Contributing: contributing.md
54+
55+
docs_dir: docs
56+
site_dir: site
57+
58+
plugins:
59+
- search
60+
61+
markdown_extensions:
62+
- pymdownx.highlight:
63+
use_pygments: true
64+
- pymdownx.superfences
65+
- pymdownx.inlinehilite
66+
- pymdownx.tabbed:
67+
alternate_style: true
68+
- pymdownx.emoji:
69+
emoji_index: !!python/name:material.extensions.emoji.twemoji
70+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
71+
- admonition
72+
- pymdownx.details
73+
- toc:
74+
permalink: true
75+
76+
extra:
77+
social:
78+
- icon: fontawesome/brands/github
79+
link: https://github.com/Ananto30/zero
80+
- icon: fontawesome/brands/python
81+
link: https://pypi.org/project/zeroapi/

0 commit comments

Comments
 (0)