Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add panels on the starter pages #2382

Open
wants to merge 2 commits into
base: latest
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/deploy-branch.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down 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: 1 addition & 1 deletion .github/workflows/deploy-custom.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
1 change: 0 additions & 1 deletion .github/workflows/destroy-deployment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ on:
jobs:
destroy-deployment:
runs-on: ubuntu-latest
container: tarantool/doc-builder:latest
steps:
- uses: actions/checkout@v2
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/pull-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,15 @@ on:
jobs:
pull-translations:
runs-on: ubuntu-latest
container: tarantool/doc-builder:latest
container: tarantool/doc-builder:fat-1

steps:
- uses: actions/checkout@v2
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
4 changes: 3 additions & 1 deletion .github/workflows/push-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,12 @@ 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

- 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: 1 addition & 1 deletion .github/workflows/update-pot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ on:
jobs:
update-translations:
runs-on: ubuntu-latest
container: tarantool/doc-builder:v1
container: tarantool/doc-builder:fat-1

steps:

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
33 changes: 7 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 Expand Up @@ -82,3 +60,6 @@
tutorials/index
contributing/index
release


.. test