-
Notifications
You must be signed in to change notification settings - Fork 36
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
fix: General cleanup #128
fix: General cleanup #128
Conversation
cshilwant
commented
Dec 16, 2024
This Demo is no longer maintained & included in any of the toc tree. Hence, purge the user guide along with associated images Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>
Use :ref: for cross-referencing to arbitrary locations in the entire document Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>
Documentation preview at - https://cshilwant.github.io/processor-sdk-doc/ |
New warnings found with rstcheck:
|
Baby steps to unblock - #16 |
@StaticRocket This seems to be a maskable warning - sphinx-doc/sphinx#11755? |
@cshilwant Also these files: linux/Foundational_Components/Kernel/Kernel_Drivers/Audio.rst, linux/Foundational_Components/Kernel/Kernel_Drivers/Display/DSS7.rst. I'm assuming you're unconcerned about non AM62** devices? |
@AashvijShenai There are many more instances where relative links are being used (apart from the one's you highlighted). Also, handling relative links in single PR won't be feasible as it would start throwing merge conflicts in almost everyone's PR |
Eh, kind of. That issue is more about providing valid absolute paths to break out of the project SOURCEDIR. Our absolute paths are supposed to be relative to the SOURCEDIR so multilevel includes and other odd things behave correctly. I think it's safe to ignore these rstcheck errors for now so long as we can verify that the path is valid. I may have a look around what's causing that if I get bored. |