diff --git a/.github/workflows/deploy-branch.yml b/.github/workflows/deploy-branch.yml index 99c6fdd661..5e9ce14daf 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: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}} diff --git a/.github/workflows/deploy-custom.yml b/.github/workflows/deploy-custom.yml index 07981fa47c..ce67e62295 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: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}} diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml index 5ecb73ad5e..bae2dabc3c 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: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}} diff --git a/.github/workflows/pull-translation.yml b/.github/workflows/pull-translation.yml index 8a78e9edaf..b0101c98ac 100644 --- a/.github/workflows/pull-translation.yml +++ b/.github/workflows/pull-translation.yml @@ -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 diff --git a/.github/workflows/push-translation.yml b/.github/workflows/push-translation.yml index 2acaf36046..6cc25f4759 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:fat-4 + container: tarantool/doc-builder:fat-4.1 steps: - uses: actions/checkout@v2 @@ -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}} \ No newline at end of file + env_url: https://crowdin.com/project/tarantool-docs/ru#/${{env.BRANCH_NAME}} diff --git a/.github/workflows/update-pot.yml b/.github/workflows/update-pot.yml index 4e25901a21..bcfecc8551 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:fat-4 + container: tarantool/doc-builder:fat-4.1 steps: diff --git a/README.rst b/README.rst index 7f432113b8..8a0983ae26 100644 --- a/README.rst +++ b/README.rst @@ -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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -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: @@ -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 `_ in the browser. @@ -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: @@ -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 --------- @@ -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. @@ -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.