You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by GitBox <gi...@apache.org> on 2020/09/11 14:15:13 UTC

[GitHub] [incubator-nuttx] v01d opened a new pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

v01d opened a new pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759


   ## Summary
   
   Add an extra step to the documentation workflow which goes through every external link and tries to access it to check if it is still valid.
   
   ## Impact
   
   CI
   
   ## Testing
   
   Tested locally, will be tested on CI for this PR


----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d closed pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d closed pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759






----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] btashton commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691218669


   Sounds good.  At least the info is here for future reference.  And yes, the matcher docs are basically non-existent, turns out they are based around the same code vscode uses, but you only find that via tickets opened against the github runner.


----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d closed pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d closed pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759


   


----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691217065


   That was my intention but I got lost in GH documentation on how to use paired with the sphinx action. I don't think it is a priority anyway. I added a "fix broken links using `make linkcheck`" task on #1638 though.


----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691150793






----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691150793


   Closing since I cannot get the link check output to be visible without failing the build (which is risky and could block unrelated PRs). 


----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] btashton commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691210688






----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] btashton commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691210688






----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d closed pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d closed pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759






----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] btashton commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
btashton commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691210688


   @v01d You can do this by enabling annotations.  See how I enabled this for nxstyle:
   https://github.com/apache/incubator-nuttx/blob/7b965a25d853f72bfc2d6d46fe35a5bab39c653d/.github/workflows/check.yml#L34
   https://github.com/apache/incubator-nuttx/blob/7b965a25d853f72bfc2d6d46fe35a5bab39c653d/.github/nxstyle.json#L13
   
   So you would still want to do the `|| true` like you had earlier, but now it would add warning annotations in the build.


----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d commented on pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d commented on pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759#issuecomment-691150793






----------------------------------------------------------------
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.

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



[GitHub] [incubator-nuttx] v01d closed pull request #1759: documentation CI: add step to check valid external links using "linkcheck" sphinx builder

Posted by GitBox <gi...@apache.org>.
v01d closed pull request #1759:
URL: https://github.com/apache/incubator-nuttx/pull/1759


   


----------------------------------------------------------------
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.

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