pine64 / bl602-docs

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

Errors/warnings when running `make html` #46

Closed username223 closed 3 years ago

username223 commented 3 years ago

When building the docs several errors pop up. Two of the error types are not trivially solvable without input.

The first is that the following image files are missing (image file not readable):

Components/Network/wifi/imgs/image1.png
Developer_Environment/eclipse/imgs/image03.png
Developer_Environment/eclipse/imgs/image06.png
Developer_Environment/freedom_studio/imgs/image06.png
Examples/benchmark_security_aes/imgs/image1.png
Examples/benchmark_security_aes/imgs/image2.png
Examples/benchmark_security_aes/imgs/image3.png
Examples/benchmark_security_aes/imgs/image4.png
Examples/benchmark_security_aes/imgs/image5.png
Examples/demo_audio_udp/imgs/image1.png
Examples/demo_audio_udp/imgs/image2.png
Examples/demo_audio_udp/imgs/image3.png
Examples/demo_cronalarm/imgs/01.png
Examples/demo_storage_romfs/imgs/image3.png

These will either need to be recreated or references removed.

The second is that two files are including files that do not exist. The including files do not include anything other than the include statement:

src/en/API/sys/cronalarms.rst
src/en/API/wifi/wifi_mgmr.rst

I'll try to look into recreating some of the missing images as well as solving some of the trivially solvable warnings.

Should the files that only include non-existing files be deleted?


Full log (reordered to group related, root is doc repo root):

/src/en/API/sys/cronalarms.rst:4: WARNING: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '_build/inc/cronalarms.inc'.
/src/en/API/wifi/wifi_mgmr.rst:4: WARNING: Problems with "include" directive path:
InputError: [Errno 2] No such file or directory: '_build/inc/wifi_mgmr_ext.inc'.

/src/en/Components/Network/wifi/wifi.rst:: WARNING: image file not readable: Components/Network/wifi/imgs/image1.png
/src/en/Developer_Environment/eclipse/eclipse.rst:: WARNING: image file not readable: Developer_Environment/eclipse/imgs/image03.png
/src/en/Developer_Environment/eclipse/eclipse.rst:: WARNING: image file not readable: Developer_Environment/eclipse/imgs/image06.png
/src/en/Developer_Environment/freedom_studio/freedom_studio.rst:: WARNING: image file not readable: Developer_Environment/freedom_studio/imgs/image06.png
/src/en/Examples/benchmark_security_aes/benchmark_security_aes_gcm.rst:: WARNING: image file not readable: Examples/benchmark_security_aes/imgs/image1.png
/src/en/Examples/benchmark_security_aes/benchmark_security_aes_gcm.rst:: WARNING: image file not readable: Examples/benchmark_security_aes/imgs/image2.png
/src/en/Examples/benchmark_security_aes/benchmark_security_aes_gcm.rst:: WARNING: image file not readable: Examples/benchmark_security_aes/imgs/image3.png
/src/en/Examples/benchmark_security_aes/benchmark_security_aes_gcm.rst:: WARNING: image file not readable: Examples/benchmark_security_aes/imgs/image4.png
/src/en/Examples/benchmark_security_aes/benchmark_security_aes_gcm.rst:: WARNING: image file not readable: Examples/benchmark_security_aes/imgs/image5.png
/src/en/Examples/demo_audio_udp/audio_udp.rst:: WARNING: image file not readable: Examples/demo_audio_udp/imgs/image1.png
/src/en/Examples/demo_audio_udp/audio_udp.rst:: WARNING: image file not readable: Examples/demo_audio_udp/imgs/image2.png
/src/en/Examples/demo_audio_udp/audio_udp.rst:: WARNING: image file not readable: Examples/demo_audio_udp/imgs/image3.png
/src/en/Examples/demo_cronalarm/cronalarm.rst:: WARNING: image file not readable: Examples/demo_cronalarm/imgs/01.png
/src/en/Examples/demo_storage_romfs/romfs.rst:: WARNING: image file not readable: Examples/demo_storage_romfs/imgs/image3.png

/src/en/Examples/demo_at/AT.rst:1: WARNING: Title overline too short.
==============
AT Commands Introduction
==============

/src/en/Examples/demo_ble/ble.rst:111: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:203: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:257: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:272: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:286: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:352: WARNING: Block quote ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:391: WARNING: Block quote ends without a blank line; unexpected unindent.

/src/en/Examples/demo_ble/ble.rst:107: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:122: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:128: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:154: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:158: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:198: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:253: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:268: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:282: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:347: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:389: WARNING: Bullet list ends without a blank line; unexpected unindent.
/src/en/Examples/demo_ble/ble.rst:407: WARNING: Bullet list ends without a blank line; unexpected unindent.

/src/en/Examples/demo_ble/ble.rst:4: WARNING: duplicate label ble-index, other instance in /src/en/Components/BLE/ble_stack/ble_stack.rst