Skip to content

Commit

Permalink
Add panels on the starter pages
Browse files Browse the repository at this point in the history
Resolve #2381
  • Loading branch information
NickVolynkin committed Nov 8, 2021
1 parent bb35dad commit 50c190b
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 26 deletions.
1 change: 1 addition & 0 deletions .github/workflows/deploy-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ jobs:
env: "branch-${{env.BRANCH_NAME}}"
ref: ${{github.head_ref}}

- run: pip install sphinx-panels
- run: cmake .
- run: make pull-modules
- run: make build-modules
Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/pull-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ jobs:
with:
token: "${{ secrets.TARANTOOLBOT_TOKEN }}"

- run: pip install sphinx-panels

- name: Set branch name from source branch
run: echo "BRANCH_NAME=${GITHUB_REF##*/}" >> $GITHUB_ENV

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/push-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ jobs:
steps:
- uses: actions/checkout@v2

- run: pip install sphinx-panels

- name: Set branch name from source branch
run: echo "BRANCH_NAME=${GITHUB_HEAD_REF##*/}" >> $GITHUB_ENV

Expand Down
2 changes: 2 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
'sphinx.ext.intersphinx',
'sphinx.ext.extlinks',
'sphinxcontrib.plantuml',
'sphinx_panels',
'ext.custom',
'ext.LuaDomain',
'ext.LuaLexer',
Expand All @@ -45,6 +46,7 @@

plantuml_output_format = 'svg_img'
imgmath_image_format = 'svg'
# panels_add_bootstrap_css = False

primary_domain = 'lua'
source_suffix = '.rst'
Expand Down
30 changes: 4 additions & 26 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,36 +7,14 @@
Tarantool - Documentation
-------------------------------------------------------------------------------

.. wp_section::
:class: documentation-main-page-header
.. panels
.. container:: documentation-main-page-header-path
This manual embraces all aspects of using Tarantool: from introductory
information and exercises for beginners -- to advanced instructions and
detailed references for power users and contributors.
|nbsp|
.. wp_section::
:class: b-documentation-toc
.. container:: documentation-main-page

.. container:: documentation-main-page-title

Tarantool documentation

.. container:: documentation-main-page-description

This manual embraces all aspects of using Tarantool: from introductory
information and exercises for beginners -- to advanced instructions and
detailed references for power users and contributors.

.. container:: documentation-main-page-content

.. ifconfig:: language == 'ru'

.. NOTE::

Документация находится в процессе перевода и может
отставать от английской версии.
.. raw:: html
Expand Down

0 comments on commit 50c190b

Please sign in to comment.