diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 09297dd946..0df827765d 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -9,6 +9,7 @@ release: before_script: - curl -L https://tarantool.io/installer.sh | VER=2.2 bash script: + - luarocks install https://raw.githubusercontent.com/tarantool/LDoc/tarantool/ldoc-scm-2.rockspec - bash update_submodules.sh - cmake . - make json json-ru singlehtml-website singlehtml-ru-website pdf pdf-ru diff --git a/.gitmodules b/.gitmodules index d1053f3f71..8cd6aa62fb 100644 --- a/.gitmodules +++ b/.gitmodules @@ -7,3 +7,6 @@ [submodule "modules/metrics"] path = modules/metrics url = https://github.com/tarantool/metrics.git +[submodule "modules/luatest"] + path = modules/luatest + url = https://github.com/tarantool/luatest diff --git a/Dockerfile b/Dockerfile index 3ca0430e37..2ee53fed3b 100644 --- a/Dockerfile +++ b/Dockerfile @@ -9,6 +9,8 @@ RUN apt update && apt install -y luarocks && \ ADD https://api.github.com/repos/tarantool/LDoc/git/refs/heads/tarantool version.json RUN git clone https://github.com/tarantool/LDoc.git /usr/local/ldoc +RUN luarocks install https://raw.githubusercontent.com/tarantool/LDoc/tarantool/ldoc-scm-2.rockspec + RUN curl -L https://tarantool.io/installer.sh | bash RUN mkdir /doc diff --git a/doc/reference/reference_rock/index.rst b/doc/reference/reference_rock/index.rst index d0747a402d..fc0271d8c5 100644 --- a/doc/reference/reference_rock/index.rst +++ b/doc/reference/reference_rock/index.rst @@ -10,6 +10,6 @@ This reference covers third-party Lua modules for Tarantool. dbms expirationd membership - shard vshard/index - tdb + ../../book/cartridge/index + luatest/luatest_overview diff --git a/doc/reference/reference_rock/luatest/luatest_overview.rst b/doc/reference/reference_rock/luatest/luatest_overview.rst new file mode 100644 index 0000000000..09a3ec291e --- /dev/null +++ b/doc/reference/reference_rock/luatest/luatest_overview.rst @@ -0,0 +1,11 @@ +********************** +Luatest +********************** + +More about Luatest API see :ref:`below `. + +.. include:: README.rst + +.. _luatest-api: + +.. include:: index.rst \ No newline at end of file diff --git a/update_submodules.sh b/update_submodules.sh index 747f9f184f..b7d0273bee 100755 --- a/update_submodules.sh +++ b/update_submodules.sh @@ -23,6 +23,14 @@ cartridge_cli_dest="${rst_dest}/cartridge_cli" cartridge_cli_index_dest="${cartridge_cli_dest}/index.rst" monitoring_root="${project_root}/modules/metrics/doc/monitoring" monitoring_dest="${project_root}/doc/book" +luatest_root="${project_root}/modules/luatest/" +luatest_dest="${project_root}/doc/reference/reference_rock/luatest" + +cd "${luatest_root}" +ldoc --ext=rst --dir=rst --toctree="API" . +cd "${luatest_dest}" +yes | cp -fa "${luatest_root}/rst/." "${luatest_dest}" +yes | cp "${luatest_root}/README.rst" "${luatest_dest}" mkdir -p "${monitoring_dest}" yes | cp -rf "${monitoring_root}" "${monitoring_dest}/" @@ -31,12 +39,8 @@ mkdir -p "${cartridge_cli_dest}" yes | cp -rf "${cartridge_cli_root}/README.rst" "${cartridge_cli_index_dest}" cd "${cartridge_root}" || exit -tarantoolctl rocks install \ - https://raw.githubusercontent.com/tarantool/LDoc/tarantool/ldoc-scm-2.rockspec \ - --server=http://rocks.moonscript.org CMAKE_DUMMY_WEBUI=true tarantoolctl rocks make - cd "${rst_src}" || exit mkdir -p "${rst_dest}" find . -iregex '.*\.\(rst\|png\)$' -exec cp -r --parents {} "${rst_dest}" \;