Skip to content
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

Integrate tracing docs into the doc website #2795

Draft
wants to merge 6 commits into
base: latest
Choose a base branch
from

Conversation

patiencedaur
Copy link
Contributor

@patiencedaur patiencedaur commented Apr 5, 2022

Resolves https://github.com/tarantool/enterprise_doc/issues/109 and https://github.com/tarantool/enterprise_doc/issues/128

TODO:

  • figure out why the redundant "Tracing for Tarantool" link appears in the toctree
  • why are the tracing API contents not displayed? (looks like an addressing problem)
  • what is the best place for the changelog?

- 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.
@github-actions github-actions bot temporarily deployed to branch-tracing-module April 5, 2022 11:36 Inactive
@github-actions github-actions bot temporarily deployed to branch-tracing-module April 6, 2022 06:14 Inactive
@github-actions github-actions bot temporarily deployed to branch-tracing-module April 12, 2022 06:42 Inactive
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.
@github-actions github-actions bot temporarily deployed to branch-tracing-module April 13, 2022 10:44 Inactive
So that the modules included in the tracing API, which is in an _included file,
still display in the left menu.
@github-actions github-actions bot temporarily deployed to branch-tracing-module April 14, 2022 05:17 Inactive
@github-actions github-actions bot temporarily deployed to branch-tracing-module April 15, 2022 09:16 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant