pine64 / bl602-docs

Documentation of the BL602 IC
https://pine64.github.io/bl602-docs/
65 stars 41 forks source link

Fix compiler warnings and enable warnings-as-errors #48

Closed username223 closed 3 years ago

username223 commented 3 years ago

This fixes https://github.com/pine64/bl602-docs/issues/46.

The images in Eclipse and Freedom Studio have been recreated to the best of my ability. The images were not essential to the article and information on how to use debug steppers is widely available anyway.

Images that were not able to be recreated due to lack of context have been replaced with the message The original documentation had an image called imgs/image1.png here, but the file is not publically available. This text is here to prevent a missing image warning.. This lets readers know that an image is missing and prevents compiler warnings.

Files that attempted to include a file that did not exist have had the include replaced with The original documentation was trying to include the file /_build/inc/cronalarms.inc which was missing from the original sources. This text is here to notify of this and prevent a missing include warning.. This lets readers know that the lack of content is a known issue.

Various small whitespace fixes to warnings have been applied as well.

This also moves the content in bl602doc_tool to BLFlashEnv, since it was included there and no other places. This removes a warning for duplicate references and removes the last Orphaned Page from the sidebar.

Warnings-as-errors have been enabled in Sphinx (-W flag) in order to prevent further warnings from coming in.