Skip to content

Add graphviz extension#678

Merged
jeevantelukula merged 2 commits intoTexasInstruments:masterfrom
sadik-smd:buildroot-12.0
Apr 22, 2026
Merged

Add graphviz extension#678
jeevantelukula merged 2 commits intoTexasInstruments:masterfrom
sadik-smd:buildroot-12.0

Conversation

@sadik-smd
Copy link
Copy Markdown
Contributor

@sadik-smd sadik-smd commented Apr 16, 2026

Summary

This PR adds a visual architecture diagram for the Buildroot-based
Linux embedded software stack targeting TI SoCs

Changes

conf.py

  • Added sphinxcontrib.graphviz to extensions list
  • Set graphviz_output_format = "svg" for crisp scalable output

Dockerfile

  • Added graphviz package

source/buildroot/Overview.rst

  • Added .. graphviz:: directive with full architecture diagram
  • Each component in the diagram is a clickable hyperlink that navigates directly to the corresponding source repository or documentation.

Preview for this architecture diagram can be found at-:
https://sadik-smd.github.io/processor-sdk-doc-fork/processor-sdk-buildroot-AM62X/esd/docs/master/buildroot/Overview.html#buildroot-architecture-for-ti-devices

@github-actions
Copy link
Copy Markdown

New warnings found with rstcheck:

source/buildroot/Overview.rst:53: (INFO/1) No directive entry for "graphviz" in module "docutils.parsers.rst.languages.en".
source/buildroot/Overview.rst:53: (ERROR/3) Unknown directive type "graphviz".

Comment thread source/buildroot/Overview.rst Outdated
@StaticRocket
Copy link
Copy Markdown
Member

StaticRocket commented Apr 17, 2026

Please add the graphviz directives to the following config:

ignore_directives = ifconfig,tabs,tab,group-tab,code-tab

@StaticRocket
Copy link
Copy Markdown
Member

Also, you may want to try and restructure that graph a little, since it's very wide and will be dynamically scaled to match the aspect ratio of the screen viewing it.

Include graphviz extension for generating flow diagrams
and add graphviz output format as SVG.
Include the graphviz package to Dockerfile and rstcheck

Signed-off-by: Mahammed Sadik Shaik <s-sadik@ti.com>
@github-actions
Copy link
Copy Markdown

New unreachable files found with check_files.py:

WARNING:root:File not used: source/buildroot/Buildroot_architecture.gv

@sadik-smd
Copy link
Copy Markdown
Contributor Author

Also, you may want to try and restructure that graph a little, since it's very wide and will be dynamically scaled to match the aspect ratio of the screen viewing it.

@StaticRocket , I have changed from two column to single column considering its width.

Preview-:https://sadik-smd.github.io/processor-sdk-doc-fork/processor-sdk-buildroot-AM62X/esd/docs/master/buildroot/Overview.html

Comment thread source/graphviz/Buildroot_architecture.gv
Add a architecture diagram for buildroot build system
using graphviz in graphviz folder and include it in
overview rst.

Signed-off-by: Mahammed Sadik Shaik <s-sadik@ti.com>
@jeevantelukula jeevantelukula merged commit d48e546 into TexasInstruments:master Apr 22, 2026
5 of 6 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.

3 participants