From bb35dad469ad363849cb3443030206d8165e4b09 Mon Sep 17 00:00:00 2001 From: Nick Volynkin Date: Mon, 8 Nov 2021 21:02:56 +0700 Subject: [PATCH 1/2] Use new docker images --- .github/workflows/deploy-branch.yml | 2 +- .github/workflows/deploy-custom.yml | 2 +- .github/workflows/destroy-deployment.yml | 1 - .github/workflows/main.yml | 2 +- .github/workflows/pull-translation.yml | 2 +- .github/workflows/push-translation.yml | 2 +- .github/workflows/update-pot.yml | 2 +- doc/index.rst | 3 +++ 8 files changed, 9 insertions(+), 7 deletions(-) diff --git a/.github/workflows/deploy-branch.yml b/.github/workflows/deploy-branch.yml index a88f2c6f64..797f81b8b9 100644 --- a/.github/workflows/deploy-branch.yml +++ b/.github/workflows/deploy-branch.yml @@ -5,7 +5,7 @@ on: jobs: deploy-branch: runs-on: ubuntu-latest - container: tarantool/doc-builder:v1 + container: tarantool/doc-builder:fat-1 env: AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}} AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}} diff --git a/.github/workflows/deploy-custom.yml b/.github/workflows/deploy-custom.yml index 812bf06613..fc0bfc823e 100644 --- a/.github/workflows/deploy-custom.yml +++ b/.github/workflows/deploy-custom.yml @@ -31,7 +31,7 @@ on: jobs: custom-deploy-branch: runs-on: ubuntu-latest - container: tarantool/doc-builder:v1 + container: tarantool/doc-builder:fat-1 env: AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}} AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}} diff --git a/.github/workflows/destroy-deployment.yml b/.github/workflows/destroy-deployment.yml index 1ba6640d16..b10e50c9f6 100644 --- a/.github/workflows/destroy-deployment.yml +++ b/.github/workflows/destroy-deployment.yml @@ -7,7 +7,6 @@ on: jobs: destroy-deployment: runs-on: ubuntu-latest - container: tarantool/doc-builder:latest steps: - uses: actions/checkout@v2 with: diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 894412703a..b4aa8b53c0 100644 --- a/.github/workflows/main.yml +++ b/.github/workflows/main.yml @@ -10,7 +10,7 @@ on: jobs: deploy: runs-on: ubuntu-latest - container: tarantool/doc-builder:v1 + container: tarantool/doc-builder:fat-1 env: AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}} AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}} diff --git a/.github/workflows/pull-translation.yml b/.github/workflows/pull-translation.yml index df4fe39cf2..70f5641366 100644 --- a/.github/workflows/pull-translation.yml +++ b/.github/workflows/pull-translation.yml @@ -8,7 +8,7 @@ on: jobs: pull-translations: runs-on: ubuntu-latest - container: tarantool/doc-builder:latest + container: tarantool/doc-builder:fat-1 steps: - uses: actions/checkout@v2 diff --git a/.github/workflows/push-translation.yml b/.github/workflows/push-translation.yml index 82e95cdc31..534505b71e 100644 --- a/.github/workflows/push-translation.yml +++ b/.github/workflows/push-translation.yml @@ -9,7 +9,7 @@ on: jobs: push-translation-sources: runs-on: ubuntu-latest - container: tarantool/doc-builder:latest + container: tarantool/doc-builder:fat-1 steps: - uses: actions/checkout@v2 diff --git a/.github/workflows/update-pot.yml b/.github/workflows/update-pot.yml index c4777a60f1..6451faa2eb 100644 --- a/.github/workflows/update-pot.yml +++ b/.github/workflows/update-pot.yml @@ -12,7 +12,7 @@ on: jobs: update-translations: runs-on: ubuntu-latest - container: tarantool/doc-builder:v1 + container: tarantool/doc-builder:fat-1 steps: diff --git a/doc/index.rst b/doc/index.rst index e18e889355..298e2b3b96 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -82,3 +82,6 @@ tutorials/index contributing/index release + + +.. test \ No newline at end of file From 50c190b07ad5b55b3bafc0ab704500607cff1683 Mon Sep 17 00:00:00 2001 From: Nick Volynkin Date: Tue, 19 Oct 2021 14:27:40 +0700 Subject: [PATCH 2/2] 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 797f81b8b9..343dfd4754 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 70f5641366..82bb1433f3 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 534505b71e..6f548c3683 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 298e2b3b96..e92ee8ffaf 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