Skip to content

source(edgeai): Handle sphinx related fixes #570

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.

Sign up for GitHub

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

Jump to bottom
Merged
StaticRocket merged 2 commits into from
Dec 11, 2025
Merged

source(edgeai): Handle sphinx related fixes #570

StaticRocket merged 2 commits into from
Dec 11, 2025

Conversation

@cshilwant
Copy link
Member

@cshilwant cshilwant commented Dec 9, 2025 

style(edgeai): Switch to :file:

Switch to role-file [0] for all references of
file names & directories in edgeai documentation.

[0] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file

Signed-off-by: Chirag Shilwant <[email protected]>

fix(edgeai): Standardize RST section headers to follow sphinx guidelines

Update all rst files under source/edgeai to conform to sphinx
guidelines for section headers [0]

[0] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

@cshilwant
style(edgeai): Switch to :file:
68e02a8 
Switch to role-file [0] for all references of
file names & directories in edgeai documentation.

[0] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-file

Signed-off-by: Chirag Shilwant <[email protected]>
@github-actions
Copy link

github-actions bot commented Dec 9, 2025

New warnings found with rstcheck:

source/edgeai/edgeai_dataflows.rst:244: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:287: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:331: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:374: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:425: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "save docker image".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "load docker image".

@github-actions
Copy link

github-actions bot commented Dec 9, 2025

New warnings found with rstcheck:

source/edgeai/edgeai_dataflows.rst:244: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:287: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:331: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:374: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:425: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "save docker image".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "load docker image".

@github-actions
Copy link

github-actions bot commented Dec 9, 2025

New warnings found with rstcheck:

source/edgeai/edgeai_dataflows.rst:244: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:287: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:331: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:374: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:425: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "save docker image".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "load docker image".

@cshilwant
Copy link
Member Author

cshilwant commented Dec 9, 2025

@StaticRocket are these valid warnings - #570 (comment) ?

@StaticRocket
Copy link
Member

StaticRocket commented Dec 9, 2025

Yeah, they are. Breaks page permalinks and lazy refs. I normally don't call it out for old doc pages but it should be avoided.

@github-actions
Copy link

github-actions bot commented Dec 11, 2025

New warnings found with rstcheck:

source/edgeai/edgeai_dataflows.rst:246: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:289: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:333: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:376: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:427: (INFO/1) Duplicate implicit target name: "multi input multi inference".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "save docker image".
source/edgeai/docker_environment.rst:5: (INFO/1) Duplicate implicit target name: "load docker image".

@github-actions
Copy link

github-actions bot commented Dec 11, 2025

New warnings found with rstcheck:

source/edgeai/edgeai_dataflows.rst:246: (INFO/1) Duplicate implicit target name: "image classification".
source/edgeai/edgeai_dataflows.rst:289: (INFO/1) Duplicate implicit target name: "object detection".
source/edgeai/edgeai_dataflows.rst:333: (INFO/1) Duplicate implicit target name: "semantic segmentation".
source/edgeai/edgeai_dataflows.rst:376: (INFO/1) Duplicate implicit target name: "single input multi inference".
source/edgeai/edgeai_dataflows.rst:427: (INFO/1) Duplicate implicit target name: "multi input multi inference".

@cshilwant
Copy link
Member Author

cshilwant commented Dec 11, 2025

@StaticRocket updated the target names to make rstcheck happy...can you please re-review

@cshilwant cshilwant force-pushed the master branch 2 times, most recently from 21dafa5 to 1861764 Compare December 11, 2025 11:54
@cshilwant
fix(edgeai): Update section headers per sphinx guidelines
40c15ae 
* Update all rst files under source/edgeai to conform to sphinx
guidelines for section headers [0]

* While at it, update few section names to fix duplicate implicit target
errors reported by rstcheck [1] & also handle fixes reported by vale [2]

[0] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#sections

[1] - https://github.com/TexasInstruments/processor-sdk-doc/blob/master/.github/workflows/rstcheck.yml

[2] - https://github.com/TexasInstruments/processor-sdk-doc/blob/master/.github/workflows/vale.yml

Signed-off-by: Chirag Shilwant <[email protected]>
@cshilwant
Copy link
Member Author

cshilwant commented Dec 11, 2025

resolved all valid vale warnings as seen at https://github.com/TexasInstruments/processor-sdk-doc/pull/570/files

ignoring Vale sentence-style capitalization as we currently ignore them & #367 is still open

@StaticRocket StaticRocket merged commit 0ac1c54 into TexasInstruments:master Dec 11, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@StaticRocket StaticRocket StaticRocket approved these changes

@jeevantelukula jeevantelukula jeevantelukula approved these changes

@praneethbajjuri praneethbajjuri Awaiting requested review from praneethbajjuri praneethbajjuri is a code owner

@uditkumarti uditkumarti Awaiting requested review from uditkumarti uditkumarti is a code owner

@gehariprasath gehariprasath Awaiting requested review from gehariprasath gehariprasath is a code owner

@VeeruPrudhvi VeeruPrudhvi Awaiting requested review from VeeruPrudhvi VeeruPrudhvi is a code owner

Assignees

@jeevantelukula jeevantelukula

@Akshay-Abdar Akshay-Abdar

@v-singh1 v-singh1

@sadik-smd sadik-smd

@yogeshhegde yogeshhegde

@PrathamTI PrathamTI

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

8 participants

@cshilwant @StaticRocket @jeevantelukula @Akshay-Abdar @v-singh1 @sadik-smd @yogeshhegde @PrathamTI