You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nuttx.apache.org by "btashton (via GitHub)" <gi...@apache.org> on 2023/05/20 03:00:49 UTC
[GitHub] [nuttx] btashton opened a new pull request, #9344: docs: Fix sphinx warnings listed in issue #9306
btashton opened a new pull request, #9344:
URL: https://github.com/apache/nuttx/pull/9344
Fixes these errors:
```
/home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/lcd.rst:52: WARNING: duplicate label ttgotdisplayesp32, other instance in /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/framebuffer.rst
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:370: CRITICAL: Unexpected section title.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:394: CRITICAL: Unexpected section title.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1494: ERROR: Inconsistent literal block quoting.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1569: WARNING: Literal block expected; none found.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst:207: WARNING: download file not readable: /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/tone.wav
checking consistency... /home/bashton/nuttx-wrk/nuttx/Documentation/reference/os/newreno.rst: WARNING: document isn't included in any toctree
/home/bashton/nuttx-wrk/nuttx/Documentation/guides/zerolatencyinterrupts.rst:117: WARNING: unknown document: <nestedinterrupts.rst>
```
## Summary
## Impact
## Testing
In master we see this build output
```
❯ make html
Removing everything under '_build'...
Running Sphinx v4.5.0
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 196 source files that are out of date
updating environment: [new config] 196 added, 0 changed, 0 removed
reading sources... [100%] reference/os/smp .. substitutions
waiting for workers...
/home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/lcd.rst:52: WARNING: duplicate label ttgotdisplayesp32, other instance in /home/bashton/nuttx-wrk/nuttx/Documentation/components/drivers/special/framebuffer.rst
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:370: CRITICAL: Unexpected section title.
Configuration
-------------
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:394: CRITICAL: Unexpected section title.
Usage
-----
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1494: ERROR: Inconsistent literal block quoting.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/sim/sim/boards/sim/index.rst:1569: WARNING: Literal block expected; none found.
/home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/index.rst:207: WARNING: download file not readable: /home/bashton/nuttx-wrk/nuttx/Documentation/platforms/xtensa/esp32s2/boards/esp32s2-kaluga-1/tone.wav
/home/bashton/nuttx-wrk/nuttx/Documentation/reference/user/structures.rst:111: WARNING: Duplicate C declaration, also defined at reference/user/07_signals:179.
Declaration is '.. c:struct:: sigaction'.
/home/bashton/nuttx-wrk/nuttx/Documentation/reference/user/structures.rst:111: WARNING: Duplicate C declaration, also defined at reference/user/07_signals:179.
Declaration is '.. c:function:: int sigaction(int signo, const struct sigaction *act, struct sigaction *oact);'.
looking for now-outdated files... none found
pickling environment... done
checking consistency... /home/bashton/nuttx-wrk/nuttx/Documentation/reference/os/newreno.rst: WARNING: document isn't included in any toctree
done
preparing documents... done
/home/bashton/nuttx-wrk/nuttx/Documentation/guides/zerolatencyinterrupts.rst:117: WARNING: unknown document: <nestedinterrupts.rst>
writing output... [100%] reference/os/smp .. substitutions
waiting for workers...
generating indices... genindex done
writing additional pages... search done
copying images... [100%] _static/images/menuconfig-debug.png
copying downloadable files... [100%] platforms/xtensa/esp32s2/boards/esp32s2-saola-1/tone.wav
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 10 warnings.
The HTML pages are in _build/html.
```
With these changes we see
```
❯ make html
Removing everything under '_build'...
Running Sphinx v4.5.0
making output directory... done
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 196 source files that are out of date
updating environment: [new config] 196 added, 0 changed, 0 removed
reading sources... [100%] reference/os/smp .. substitutions
waiting for workers...
/home/bashton/nuttx-wrk/nuttx/Documentation/reference/user/structures.rst:111: WARNING: Duplicate C declaration, also defined at reference/user/07_signals:179.
Declaration is '.. c:struct:: sigaction'.
/home/bashton/nuttx-wrk/nuttx/Documentation/reference/user/structures.rst:111: WARNING: Duplicate C declaration, also defined at reference/user/07_signals:179.
Declaration is '.. c:function:: int sigaction(int signo, const struct sigaction *act, struct sigaction *oact);'.
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
writing output... [100%] reference/os/smp .. substitutions
waiting for workers...
generating indices... genindex done
writing additional pages... search done
copying images... [100%] _static/images/menuconfig-debug.png
copying downloadable files... [100%] platforms/xtensa/esp32s2/boards/esp32s2-saola-1/tone.wav
copying static files... done
copying extra files... done
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.
The HTML pages are in _build/html.
```
`WARNING: Duplicate C declaration,` is expected and tracked as an upstream sphinx bug.
--
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
[GitHub] [nuttx] btashton commented on pull request #9344: docs: Fix sphinx warnings listed in issue #9306
Posted by "btashton (via GitHub)" <gi...@apache.org>.
btashton commented on PR #9344:
URL: https://github.com/apache/nuttx/pull/9344#issuecomment-1555534271
> @btashton could we enable the doc build warning to error? So, the similar thing can be caught before merging.
I would love to, but we cannot silence the Warning Duplicate declaration error for C, and that is caused by what this PR is trying to resolve. https://github.com/sphinx-doc/sphinx/pull/8313 There are other projects that have added a plugin to regex whitelist warnings like this. We could build that as well if we wanted.
--
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
[GitHub] [nuttx] xiaoxiang781216 merged pull request #9344: docs: Fix sphinx warnings listed in issue #9306
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 merged PR #9344:
URL: https://github.com/apache/nuttx/pull/9344
--
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
[GitHub] [nuttx] xiaoxiang781216 commented on pull request #9344: docs: Fix sphinx warnings listed in issue #9306
Posted by "xiaoxiang781216 (via GitHub)" <gi...@apache.org>.
xiaoxiang781216 commented on PR #9344:
URL: https://github.com/apache/nuttx/pull/9344#issuecomment-1555520683
@btashton could we enable the doc build warning to error? So, the similar thing can be caught before merging.
--
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