-
-
Notifications
You must be signed in to change notification settings - Fork 293
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
[GSK-2236] Fixing docs #1645
[GSK-2236] Fixing docs #1645
Conversation
rabah-khalek
commented
Nov 28, 2023
•
edited
Loading
edited
- added text generations to the test catalog
- standardizing index.rst for all main modules
- 1:1 mapping between cells and TOC
- introduced community cell
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
checking consistency... /home/bazire/giskard/docs/community/index.rst: WARNING: document isn't included in any toctree
/home/bazire/giskard/docs/giskard_hub/index.rst: WARNING: document isn't included in any toctree
/home/bazire/giskard/docs/knowledge/index.rst: WARNING: document isn't included in any toctree
/home/bazire/giskard/docs/open_source/index.rst: WARNING: document isn't included in any toctree
Could you fix these warnings also ?
docs/giskard_hub/index.rst
Outdated
Giskard Hub | ||
=============== | ||
|
||
.. toctree:: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as for integrations :
Should we use :hidden: here, and use cards instead ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
forgot to tick that
@Hartorn do you have an idea on how to silence these warnings in case I don't want to include some indexes in tocs (the reason being, they're alone in the category) |
I would add them to an octree but with :hidden: Also, if they are not in any octree, they are not accessible, except if you have some links in card. So i would create the hidden octree at the same place maybe |
Kudos, SonarCloud Quality Gate passed! |