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

fix: General cleanup #128

Merged
merged 2 commits into from
Dec 16, 2024
Merged

Conversation

cshilwant
Copy link
Member

fix(system): Drop User Guide for Servo Drive Demo

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>
fix: Switch from relative links to :ref: for cross-referencing

Use :ref: for cross-referencing to arbitrary locations in the entire document

Signed-off-by: Chirag Shilwant <c-shilwant@ti.com>

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>
@cshilwant
Copy link
Member Author

Documentation preview at - https://cshilwant.github.io/processor-sdk-doc/

Copy link

New warnings found with rstcheck:

source/devices/AM62X/linux/Release_Specific_Migration_Guide.rst:49: (SEVERE/4) Problems with "include" directive path:

@cshilwant
Copy link
Member Author

Baby steps to unblock - #16

@cshilwant
Copy link
Member Author

cshilwant commented Dec 16, 2024

New warnings found with rstcheck:

source/devices/AM62X/linux/Release_Specific_Migration_Guide.rst:49: (SEVERE/4) Problems with "include" directive path:

@StaticRocket This seems to be a maskable warning - sphinx-doc/sphinx#11755?

@AashvijShenai
Copy link
Collaborator

AashvijShenai commented Dec 16, 2024

@cshilwant
I notice that AM62AX docs did not get this update. Is this intentional? (devices/AM62AX/linux/Release_Specific_Migration_Guide.rst, devices/AM62AX/linux/Overview/Build_and_Run_the_Demos.rst)

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?

@cshilwant
Copy link
Member Author

@cshilwant I notice that AM62AX docs did not get this update. Is this intentional? (devices/AM62AX/linux/Release_Specific_Migration_Guide.rst, devices/AM62AX/linux/Overview/Build_and_Run_the_Demos.rst)

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).
As mentioned in #128 (comment), just addressed few of those which were known to me.

Also, handling relative links in single PR won't be feasible as it would start throwing merge conflicts in almost everyone's PR

@StaticRocket
Copy link
Member

New warnings found with rstcheck:

source/devices/AM62X/linux/Release_Specific_Migration_Guide.rst:49: (SEVERE/4) Problems with "include" directive path:

@StaticRocket This seems to be a maskable warning - sphinx-doc/sphinx#11755?

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.

@StaticRocket StaticRocket merged commit be5ca4f into TexasInstruments:master Dec 16, 2024
2 of 3 checks passed
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.