Integrate tracing docs into the doc website#2795
Draft
patiencedaur wants to merge 6 commits intolatestfrom
Draft
Integrate tracing docs into the doc website#2795patiencedaur wants to merge 6 commits intolatestfrom
patiencedaur wants to merge 6 commits intolatestfrom
Conversation
- Submodule builder now pulls content from the tracing submodule - Git now ignores content pulled while building the docs - Add an overview page for tracing, accessible from the rocks reference index https://github.com/tarantool/doc/pull/1614/files does something similar.
Seems like the usual addressing rules don't work in sphinx. I provided "incorrect" addresses that display correct results against all logic. Normally, a link like "tracing/modules/filename" in the toctree would lead you two levels down. However, when this kind of link is provided in a file in an `_includes` directory, it seems to jump one level up first and then go down the tree, ending up in the right place. At the same time, build logs show errors. Thus, an incorrect link, recognized by Sphinx as such, provides the right result when parsed. Error + error = no error.
So that the modules included in the tracing API, which is in an _included file, still display in the left menu.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolves https://github.com/tarantool/enterprise_doc/issues/109 and https://github.com/tarantool/enterprise_doc/issues/128
TODO: