Skip to content

Commit a8cf5de

Browse files
committed
Add panels on the starter pages
Resolve #2381
1 parent cd24361 commit a8cf5de

File tree

5 files changed

+11
-26
lines changed

5 files changed

+11
-26
lines changed

.github/workflows/deploy-branch.yml

+1
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@ jobs:
3434
env: "branch-${{env.BRANCH_NAME}}"
3535
ref: ${{github.head_ref}}
3636

37+
- run: pip install sphinx-panels
3738
- run: cmake .
3839
- run: make pull-modules
3940
- run: make build-modules

.github/workflows/pull-translation.yml

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ jobs:
1515
with:
1616
token: "${{ secrets.TARANTOOLBOT_TOKEN }}"
1717

18+
- run: pip install sphinx-panels
19+
1820
- name: Set branch name from source branch
1921
run: echo "BRANCH_NAME=${GITHUB_REF##*/}" >> $GITHUB_ENV
2022

.github/workflows/push-translation.yml

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ jobs:
1313
steps:
1414
- uses: actions/checkout@v2
1515

16+
- run: pip install sphinx-panels
17+
1618
- name: Set branch name from source branch
1719
run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV
1820

conf.py

+2
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',
@@ -45,6 +46,7 @@
4546

4647
plantuml_output_format = 'svg_img'
4748
imgmath_image_format = 'svg'
49+
# panels_add_bootstrap_css = False
4850

4951
primary_domain = 'lua'
5052
source_suffix = '.rst'

doc/index.rst

+4-26
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,14 @@
77
Tarantool - Documentation
88
-------------------------------------------------------------------------------
99

10-
.. wp_section::
11-
:class: documentation-main-page-header
10+
.. panels
1211
13-
.. container:: documentation-main-page-header-path
12+
This manual embraces all aspects of using Tarantool: from introductory
13+
information and exercises for beginners -- to advanced instructions and
14+
detailed references for power users and contributors.
1415
15-
|nbsp|
1616
17-
.. wp_section::
18-
:class: b-documentation-toc
1917
20-
.. container:: documentation-main-page
21-
22-
.. container:: documentation-main-page-title
23-
24-
Tarantool documentation
25-
26-
.. container:: documentation-main-page-description
27-
28-
This manual embraces all aspects of using Tarantool: from introductory
29-
information and exercises for beginners -- to advanced instructions and
30-
detailed references for power users and contributors.
31-
32-
.. container:: documentation-main-page-content
33-
34-
.. ifconfig:: language == 'ru'
35-
36-
.. NOTE::
37-
38-
Документация находится в процессе перевода и может
39-
отставать от английской версии.
4018
4119
.. raw:: html
4220

0 commit comments

Comments
 (0)