Skip to content

Commit d500feb

Browse files
committed
Use sphinx-panels
1 parent ea8024c commit d500feb

File tree

8 files changed

+169
-6
lines changed

8 files changed

+169
-6
lines changed

.github/workflows/deploy-branch.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ on:
55
jobs:
66
deploy-branch:
77
runs-on: ubuntu-latest
8-
container: tarantool/doc-builder:fat-2
8+
container: tarantool/doc-builder:fat-2.1
99
env:
1010
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
1111
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

.github/workflows/deploy-custom.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ on:
3131
jobs:
3232
custom-deploy-branch:
3333
runs-on: ubuntu-latest
34-
container: tarantool/doc-builder:fat-2
34+
container: tarantool/doc-builder:fat-2.1
3535
env:
3636
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
3737
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

.github/workflows/main.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ on:
1010
jobs:
1111
deploy:
1212
runs-on: ubuntu-latest
13-
container: tarantool/doc-builder:fat-2
13+
container: tarantool/doc-builder:fat-2.1
1414
env:
1515
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
1616
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}

.github/workflows/pull-translation.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ on:
1313
jobs:
1414
pull-translations:
1515
runs-on: ubuntu-latest
16-
container: tarantool/doc-builder:fat-2
16+
container: tarantool/doc-builder:fat-2.1
1717

1818
steps:
1919
- uses: actions/checkout@v2

.github/workflows/push-translation.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
jobs:
1010
push-translation-sources:
1111
runs-on: ubuntu-latest
12-
container: tarantool/doc-builder:fat-2
12+
container: tarantool/doc-builder:fat-2.1
1313
steps:
1414
- uses: actions/checkout@v2
1515

.github/workflows/update-pot.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ on:
1212
jobs:
1313
update-translations:
1414
runs-on: ubuntu-latest
15-
container: tarantool/doc-builder:fat-2
15+
container: tarantool/doc-builder:fat-2.1
1616

1717
steps:
1818

conf.py

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
'sphinx.ext.intersphinx',
2323
'sphinx.ext.extlinks',
2424
'sphinxcontrib.plantuml',
25+
'sphinx_panels',
2526
'ext.custom',
2627
'ext.LuaDomain',
2728
'ext.LuaLexer',

doc/index.rst

+162
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,168 @@
77
Tarantool - Documentation
88
-------------------------------------------------------------------------------
99

10+
This manual embraces all aspects of using Tarantool:
11+
from introductory information and exercises for beginners --- to advanced instructions
12+
and detailed references for power users and contributors.
13+
14+
15+
.. panels::
16+
:container: doc-cards
17+
:column: doc-card doc-card_medium
18+
:card: doc-card__content
19+
:header: doc-card__title
20+
:body: doc-card__text
21+
:footer: doc-card__link
22+
23+
:column: doc-card doc-card_getting-started
24+
Getting Started
25+
26+
^^^
27+
28+
In this chapter, we show how to work with Tarantool as a DBMS ---
29+
and how to connect to a Tarantool database from other programming languages.
30+
31+
+++
32+
33+
:doc:`Create your first Tarantool database </getting_started/getting_started_db>`
34+
35+
---
36+
37+
Application server
38+
39+
^^^
40+
41+
Working with Tarantool as a Lua application server.
42+
43+
---
44+
45+
Data model
46+
47+
^^^
48+
49+
How Tarantool stores values and what operations with data it supports.
50+
51+
---
52+
53+
Administration
54+
55+
^^^
56+
57+
How to administer Tarantool instances using ``systemd`` and ``tarantoolctl`` utilities.
58+
59+
---
60+
61+
CRUD operations
62+
63+
^^^
64+
65+
How the create, read, update and delete operations are implemented in Tarantool.
66+
67+
68+
Main page example
69+
-----------------
70+
71+
72+
.. panels::
73+
:container: doc-cards
74+
:column: doc-card doc-card_small
75+
:card: doc-card__content
76+
:header: doc-card__logo
77+
:body: doc-card__title
78+
:footer: doc-card__text
79+
80+
81+
:column: doc-card doc-card_getting-started
82+
Getting Started
83+
84+
^^^
85+
86+
In this chapter, we show how to work with Tarantool as a DBMS ---
87+
and how to connect to a Tarantool database from other programming languages.
88+
89+
+++
90+
91+
:doc:`Create your first Tarantool database </getting_started/getting_started_db>`
92+
93+
---
94+
95+
[img]
96+
97+
^^^
98+
99+
Tarantool Community Edition
100+
101+
+++
102+
103+
In-memory computing platform
104+
105+
---
106+
107+
[img]
108+
109+
^^^
110+
111+
Tarantool Data Grid
112+
113+
+++
114+
115+
Enterprise data services with ease.
116+
117+
---
118+
119+
120+
[img]
121+
122+
^^^
123+
124+
Tarantool Enterprise
125+
126+
+++
127+
128+
Enterprise data services with ease.
129+
130+
---
131+
132+
133+
[img]
134+
135+
^^^
136+
137+
Tarantool Cartridge
138+
139+
+++
140+
141+
Enterprise data services with ease.
142+
143+
---
144+
145+
146+
[img]
147+
148+
^^^
149+
150+
Drivers
151+
152+
+++
153+
154+
Enterprise data services with ease.
155+
156+
---
157+
158+
159+
[img]
160+
161+
^^^
162+
163+
Tools
164+
165+
+++
166+
167+
Enterprise data services with ease.
168+
169+
---
170+
171+
10172
.. wp_section::
11173
:class: documentation-main-page-header
12174

0 commit comments

Comments
 (0)