Skip to content

Build docs in image tarantool/doc-builder:fat-4.1 #2967

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

Merged
merged 1 commit into from
Jun 22, 2022
Merged
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
2 changes: 1 addition & 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:fat-4
container: tarantool/doc-builder:fat-4.1
env:
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
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:fat-4
container: tarantool/doc-builder:fat-4.1
env:
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
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:fat-4
container: tarantool/doc-builder:fat-4.1
env:
AWS_ACCESS_KEY_ID: ${{secrets.AWS_ACCESS_KEY_ID}}
AWS_SECRET_ACCESS_KEY: ${{secrets.AWS_SECRET_ACCESS_KEY}}
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pull-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ on:
jobs:
pull-translations:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-4
container: tarantool/doc-builder:fat-4.1

steps:
- uses: actions/checkout@v2
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/push-translation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ on:
jobs:
push-translation-sources:
runs-on: ubuntu-latest
container: tarantool/doc-builder:fat-4
container: tarantool/doc-builder:fat-4.1
steps:
- uses: actions/checkout@v2

Expand Down Expand Up @@ -47,4 +47,4 @@ jobs:
token: ${{secrets.GITHUB_TOKEN}}
status: ${{job.status}}
deployment_id: ${{steps.translation.outputs.deployment_id}}
env_url: https://crowdin.com/project/tarantool-docs/ru#/${{env.BRANCH_NAME}}
env_url: https://crowdin.com/project/tarantool-docs/ru#/${{env.BRANCH_NAME}}
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:fat-4
container: tarantool/doc-builder:fat-4.1

steps:

Expand Down
42 changes: 21 additions & 21 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ First of all, pull the image for building the docs.

.. code-block:: bash

docker pull tarantool/doc-builder:fat-4
docker pull tarantool/doc-builder:fat-4.1

Next, initialize a Makefile for your OS:

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "cmake ."
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "cmake ."

Update submodules and generate documentation sources from code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -61,13 +61,13 @@ To include their latest contents in the docs, run these two steps.

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make pull-modules"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make pull-modules"

2. Build the submodules content:

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make build-modules"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make build-modules"

This command will do two things:

Expand All @@ -89,7 +89,7 @@ and refresh the browser page.

.. code-block:: bash

docker run --rm -it -p 8000:8000 -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make autobuild"
docker run --rm -it -p 8000:8000 -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make autobuild"

First build will take some time.
When it's done, open `127.0.0.1:8000 <http://127.0.0.1:8000>`_ in the browser.
Expand All @@ -101,8 +101,8 @@ and then serve them using python3 built-in server:

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html-ru"
python3 -m http.server --directory output/html

or python2 built-in server:
Expand All @@ -119,17 +119,17 @@ in the ``tarantool/doc-builder`` container:

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make html-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make singlehtml"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make singlehtml-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make pdf"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make pdf-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make json"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make json-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make epub"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make epub-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make update-po"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make html-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make singlehtml"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make singlehtml-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make pdf"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make pdf-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make json"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make json-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make epub"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make epub-ru"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make update-po"

Linkcheck
---------
Expand All @@ -138,13 +138,13 @@ There's a specific build mode which checks internal and external links instead o

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make linkcheck"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make linkcheck"

If you need to save the linkcheck's report in a file, you can use the following trick:

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make linkcheck" 2>&1 | tee linkcheck.log
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make linkcheck" 2>&1 | tee linkcheck.log

Here ``2>&1`` redirects the ``stderr`` output to ``stdout``, and then ``tee`` both
shows in on screen and writes to a file.
Expand All @@ -167,7 +167,7 @@ To update the translation files, run the `make update-po` task:

.. code-block:: bash

docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4 sh -c "make update-po"
docker run --rm -it -v $(pwd):/doc tarantool/doc-builder:fat-4.1 sh -c "make update-po"

Translate the strings in the updated files and then commit the changes.

Expand Down