Skip to content

Conversation

@danish-ti
Copy link
Contributor

This patch updates the PRU_ICSSG_Ethernet.rst and
PRU_ICSSG_Ethernet_Switch.rst documentation files to improve Sphinx compatibility and readability. The following changes are made:

  • Replaces all occurrences of "::" used for literal/code blocks with ".. code-block:: console" and ensures proper indentation for code examples and command-line snippets.
  • Updates all code and command output blocks to use the correct Sphinx directive, which enables syntax highlighting and consistent formatting in generated documentation.
  • Fixes minor typos in comments and documentation text, such as correcting "Fore more details" to "For more details" and improving clarity.
  • Ensures consistent formatting of code blocks, command outputs, and configuration examples throughout the documentation.
  • No functional or content changes are made to the technical information; all updates are limited to documentation formatting and style.

@github-actions
Copy link

github-actions bot commented Jul 4, 2025

New warnings found with rstcheck:

source/linux/Foundational_Components/PRU-ICSS/Linux_Drivers/PRU_ICSSG_Ethernet_Switch.rst:38: (WARNING/2) Cannot analyze code. No Pygments lexer found for "console:".

@danish-ti danish-ti force-pushed the pru-sphinx-fix branch 3 times, most recently from 8b34163 to ce969c8 Compare July 4, 2025 09:11
This patch updates the PRU_ICSSG_Ethernet.rst and
PRU_ICSSG_Ethernet_Switch.rst documentation files to improve Sphinx
compatibility and readability. The following changes are made:

- Replaces all occurrences of "::" used for literal/code blocks with
  ".. code-block:: console" and ensures proper indentation for code
  examples and command-line snippets.
- Updates all code and command output blocks to use the correct Sphinx
  directive, which enables syntax highlighting and consistent formatting
  in generated documentation.
- Fixes minor typos in comments and documentation text, such as correcting
  "Fore more details" to "For more details" and improving clarity.
- Ensures consistent formatting of code blocks, command outputs, and
  configuration examples throughout the documentation.
- No functional or content changes are made to the technical information;
  all updates are limited to documentation formatting and style.

Signed-off-by: MD Danish Anwar <[email protected]>
@praneethbajjuri praneethbajjuri merged commit c61b21a into TexasInstruments:master Jul 9, 2025
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.

6 participants