Skip to content

gh-1580 rocks reference update #1614

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 3 commits into from
Oct 21, 2020
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
1 change: 1 addition & 0 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ release:
before_script:
- curl -L https://tarantool.io/installer.sh | VER=2.2 bash
script:
- luarocks install https://github.com/raw/tarantool/LDoc/tarantool/ldoc-scm-2.rockspec
- bash update_submodules.sh
- cmake .
- make json json-ru singlehtml-website singlehtml-ru-website pdf pdf-ru
Expand Down
3 changes: 3 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ RUN apt update && apt install -y luarocks && \
ADD https://github.com/api/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://github.com/raw/tarantool/LDoc/tarantool/ldoc-scm-2.rockspec

RUN curl -L https://tarantool.io/installer.sh | bash

RUN mkdir /doc
Expand Down
4 changes: 2 additions & 2 deletions doc/reference/reference_rock/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
11 changes: 11 additions & 0 deletions doc/reference/reference_rock/luatest/luatest_overview.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
**********************
Luatest
**********************

More about Luatest API see :ref:`below <luatest-api>`.

.. include:: README.rst

.. _luatest-api:

.. include:: index.rst
12 changes: 8 additions & 4 deletions update_submodules.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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}/"
Expand All @@ -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://github.com/raw/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}" \;
Expand Down