diff --git a/.gitignore b/.gitignore index d248b8e00e..12cd851d9d 100644 --- a/.gitignore +++ b/.gitignore @@ -74,3 +74,9 @@ locale/* /doc/getting_started/getting_started_cxx.rst /doc/getting_started/_includes/ /doc/book/connectors/cxx/ + +# tracing submodule: leaving only tracing_overview + +/doc/reference/reference_rock/tracing/ +/locale/en/reference/reference_rock/tracing/ +/locale/ru/LC_MESSAGES/reference/reference_rock/tracing/ diff --git a/.gitmodules b/.gitmodules index 3efe9f8560..13228360f4 100644 --- a/.gitmodules +++ b/.gitmodules @@ -19,3 +19,6 @@ [submodule "modules/tntcxx"] path = modules/tntcxx url = https://github.com/tarantool/tntcxx.git +[submodule "modules/tracing"] + path = modules/tracing + url = https://github.com/tarantool/tracing diff --git a/build_submodules.sh b/build_submodules.sh index 40dc39f176..d1bdac46b0 100755 --- a/build_submodules.sh +++ b/build_submodules.sh @@ -107,3 +107,23 @@ mkdir -p "${tntcxx_gs_dest}/_includes" yes | cp -rf "${tntcxx_root}/doc/tntcxx_getting_started.rst" "${tntcxx_gs_dest}/getting_started_cxx.rst" yes | cp -rf "${tntcxx_root}/examples/" "${tntcxx_gs_dest}/_includes/examples/" yes | cp -rf "${tntcxx_root}/doc/tntcxx_api.rst" "${tntcxx_api_dest}/cxx/" + + +# Tracing module +tracing_root="${project_root}/modules/tracing" +tracing_dest="${project_root}/doc/reference/reference_rock/tracing" + +# Generate tracing docs +cd "${tracing_root}" +ldoc --ext=rst --dir=rst --toctree="API" . + +# Copy tracing docs to the right place +mkdir -p "${tracing_dest}/_includes/" +yes | cp -fa "${tracing_root}/rst/." "${tracing_dest}" +pandoc -f gfm -t rst -o "${tracing_dest}/_includes/readme.rst" "${tracing_root}/README.md" +yes | mv -f "${tracing_dest}/index.rst" "${tracing_dest}/_includes/api.rst" +# remove header from included README file +sed -i '1,3d' "${tracing_dest}/_includes/readme.rst" +# edit paths in the included API file +# Addressing in sphinx includes sometimes defies common logic +sed -i 's,modules,tracing\/modules,g' "${tracing_dest}/_includes/api.rst" diff --git a/doc/reference/reference_rock/index.rst b/doc/reference/reference_rock/index.rst index 7282555e69..03ed5dc2de 100644 --- a/doc/reference/reference_rock/index.rst +++ b/doc/reference/reference_rock/index.rst @@ -7,12 +7,13 @@ Rocks reference This reference covers third-party Lua modules for Tarantool. -.. toctree:: - :maxdepth: 2 +.. toctree:: + :maxdepth: 1 - dbms + Module cartridge expirationd + Module luatest membership + Module tracing vshard/index - ../../book/cartridge/index - luatest/luatest_overview + dbms diff --git a/doc/reference/reference_rock/luatest/luatest_overview.rst b/doc/reference/reference_rock/luatest/luatest_overview.rst index ba1403ff3f..ab6bd11e97 100644 --- a/doc/reference/reference_rock/luatest/luatest_overview.rst +++ b/doc/reference/reference_rock/luatest/luatest_overview.rst @@ -1,6 +1,5 @@ -********************** -Luatest -********************** +Module luatest +============== More about Luatest API see :ref:`below `. @@ -8,4 +7,5 @@ More about Luatest API see :ref:`below `. .. _luatest-api: -.. include:: _includes/index.rst \ No newline at end of file +.. include:: _includes/index.rst + \ No newline at end of file diff --git a/doc/reference/reference_rock/tracing_overview.rst b/doc/reference/reference_rock/tracing_overview.rst new file mode 100644 index 0000000000..5f1ec3902b --- /dev/null +++ b/doc/reference/reference_rock/tracing_overview.rst @@ -0,0 +1,19 @@ +Module tracing +============== + +More about ``tracing`` API see :ref:`below `. + +.. include:: tracing/_includes/readme.rst + +.. _tracing-api: + +.. include:: tracing/_includes/api.rst + +.. toctree:: + :maxdepth: 1 + + tracing/modules/opentracing + tracing/modules/opentracing.span + tracing/modules/opentracing.span_context + tracing/modules/opentracing.tracer + tracing/modules/zipkin.tracer diff --git a/modules/tracing b/modules/tracing new file mode 160000 index 0000000000..0b5d7d2560 --- /dev/null +++ b/modules/tracing @@ -0,0 +1 @@ +Subproject commit 0b5d7d2560d5c5feca286cdb8145cbdbd6e2ca34