You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "rcsim (via GitHub)" <gi...@apache.org> on 2023/11/25 16:15:04 UTC

[PR] Documentation: Fix errors on linum-stm32h753bi [nuttx]

rcsim opened a new pull request, #11266:
URL: https://github.com/apache/nuttx/pull/11266

   ## Summary
   Fix errors on linum-stm32h753bi
   
   >  /home/rcsim/Workspace/learning/nuttx/nuttxspace/nuttx/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst:106: ERROR: Malformed table.
   > Text in column margin in table line 2.
   > 
   > ====== =====
   > UART4 PINS
   > ====== =====
   > TXD    PB9
   > RXD    PB8
   > DE     PA15
   > ====== =====
   > /home/rcsim/Workspace/learning/nuttx/nuttxspace/nuttx/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst:236: ERROR: Malformed table.
   > Bottom/header table border does not match top border.
   > 
   > ======== =====
   > GPIO     PINS
   > ======== =====
   > TS_RESET PI7
   > TS_ISR   PH9
   > ========  =====
   > /home/rcsim/Workspace/learning/nuttx/nuttxspace/nuttx/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst:338: ERROR: Malformed table.
   > No bottom table border found or no blank line after table bottom.
   > 
   > ============= =====
   > PWM           PINS
   > ============= =====
   > /home/rcsim/Workspace/learning/nuttx/nuttxspace/nuttx/Documentation/platforms/arm/stm32h7/boards/linum-stm32h753bi/index.rst:341: WARNING: Blank line required after table.
   
   ## Impact
    No errors related to linum board during Documentation build
   
   ## Testing
   ![image](https://github.com/apache/nuttx/assets/30301531/bdfde0c6-d74e-43e4-b3f3-a583e6fc6164)
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Documentation: Fix errors on linum-stm32h753bi [nuttx]

Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 merged PR #11266:
URL: https://github.com/apache/nuttx/pull/11266


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Documentation: Fix errors on linum-stm32h753bi [nuttx]

Posted by "raiden00pl (via GitHub)" <gi...@apache.org>.
raiden00pl commented on PR #11266:
URL: https://github.com/apache/nuttx/pull/11266#issuecomment-1827432922

   @xiaoxiang781216 @btashton 
   Maybe we can port Zephyr solution for this problem: https://docs.zephyrproject.org/latest/contribute/documentation/generation.html#filtering-expected-warnings 
   I'll see if it works for us.
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Documentation: Fix errors on linum-stm32h753bi [nuttx]

Posted by "btashton (via GitHub)" <gi...@apache.org>.
btashton commented on PR #11266:
URL: https://github.com/apache/nuttx/pull/11266#issuecomment-1826474385

   https://github.com/apache/nuttx/pull/9344#issuecomment-1555534271
   
   
   Possible we could catch more by limiting what we exclude. Although I don't remember this working well for us 
   https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-suppress_warnings
   
   If we can make that work we can pass `-W` and make warnings treated as errors. 
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org


Re: [PR] Documentation: Fix errors on linum-stm32h753bi [nuttx]

Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 commented on PR #11266:
URL: https://github.com/apache/nuttx/pull/11266#issuecomment-1826466881

   @raiden00pl @btashton can we improve the documentation ci to catch this type of error?


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@nuttx.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org