From a8cf5dedd86a808314d36fb9083158e6c85597fa Mon Sep 17 00:00:00 2001 From: Nick Volynkin Date: Tue, 19 Oct 2021 14:27:40 +0700 Subject: [PATCH] Add panels on the starter pages Resolve #2381 --- .github/workflows/deploy-branch.yml | 1 + .github/workflows/pull-translation.yml | 2 ++ .github/workflows/push-translation.yml | 2 ++ conf.py | 2 ++ doc/index.rst | 30 ++++---------------------- 5 files changed, 11 insertions(+), 26 deletions(-) diff --git a/.github/workflows/deploy-branch.yml b/.github/workflows/deploy-branch.yml index a88f2c6f64..2ab4e23a16 100644 --- a/.github/workflows/deploy-branch.yml +++ b/.github/workflows/deploy-branch.yml @@ -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 diff --git a/.github/workflows/pull-translation.yml b/.github/workflows/pull-translation.yml index df4fe39cf2..787a5437f3 100644 --- a/.github/workflows/pull-translation.yml +++ b/.github/workflows/pull-translation.yml @@ -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 diff --git a/.github/workflows/push-translation.yml b/.github/workflows/push-translation.yml index 82e95cdc31..6571b04dce 100644 --- a/.github/workflows/push-translation.yml +++ b/.github/workflows/push-translation.yml @@ -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 diff --git a/conf.py b/conf.py index 4267a42585..fed7114e4e 100644 --- a/conf.py +++ b/conf.py @@ -22,6 +22,7 @@ 'sphinx.ext.intersphinx', 'sphinx.ext.extlinks', 'sphinxcontrib.plantuml', + 'sphinx_panels', 'ext.custom', 'ext.LuaDomain', 'ext.LuaLexer', @@ -45,6 +46,7 @@ plantuml_output_format = 'svg_img' imgmath_image_format = 'svg' +# panels_add_bootstrap_css = False primary_domain = 'lua' source_suffix = '.rst' diff --git a/doc/index.rst b/doc/index.rst index e18e889355..2306e95fd2 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -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