Re: [PR] doc: Migrating the rest of documentation from cwiki. [nuttx]
xiaoxiang781216 merged PR #18970: URL: https://github.com/apache/nuttx/pull/18970 -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] doc: Migrating the rest of documentation from cwiki. [nuttx]
cederom commented on PR #18970:
URL: https://github.com/apache/nuttx/pull/18970#issuecomment-4559839450
* Okay, one typo fixed, and I one cross-section label fixed :-) Other than
that I checked everything for few days before the PR I hope the results are
good :-)
* Looks like `make html` that is used to build the website is more strict
than `sphinx-autobuild` beware :-)
* That was quite a journey with RST and Sphinx. Now I get better
understanding of the formatting :-)
```
% gmake html
Removing everything under '_build'...
Running Sphinx v7.3.7
myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False,
enable_extensions=set(), disable_syntax=[], all_links_external=False,
links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'),
ref_domains=None, fence_as_directive=set(), number_code_blocks=[],
title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={},
footnote_transition=True, words_per_minute=200, substitutions={},
linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True,
dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True,
mathjax_classes='tex2jax_process|mathjax_process|math|output_area',
enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
Tags updated
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 1602 source files that are out of date
updating environment: [new config] 1602 added, 0 changed, 0 removed
reading sources... [ 42%]
components/drivers/character/analog/dac/mcp47x6/index ..
components/drivers/character
reading sources... [ 46%] components/drivers/special/mtd/devices/sst39vf ..
components/drivers/special/rptun/dr
reading sources... [ 48%] components/drivers/special/rptun/index ..
components/drivers/special/sensors/sensors_
reading sources... [ 66%] platforms/arm/a1x/boards/pcduino-a10/index ..
platforms/arm/gd32f4/boards/gd32f470zk-
reading sources... [ 68%] platforms/arm/gd32f4/boards/gd32f470zk-eval/index
.. platforms/arm/kinetis/boards/fre
reading sources... [ 71%] platforms/arm/lpc2378/boards/olimex-lpc2378/index
.. platforms/arm/nrf52/boards/nrf52
reading sources... [ 74%] platforms/arm/ra4m1/boards/arduino-r4-minima/index
.. platforms/arm/s32k3xx/boards/mr
reading sources... [ 77%] platforms/arm/samd5e5/boards/metro-m4/index ..
platforms/arm/stm32f1/boards/stm3210e-
reading sources... [ 78%] platforms/arm/stm32f1/boards/stm32_tiny/index ..
platforms/arm/stm32f4/boards/nucleo-
reading sources... [ 83%] platforms/arm/stm32l0/boards/b-l072z-lrwan1/index
.. platforms/arm/stm32wb/boards/nuc
reading sources... [ 94%]
platforms/tricore/tc397/boards/kit_a2g_tc397_tft/index ..
platforms/xtensa/esp32s3/bo
reading sources... [100%] testing/nuttx-ci .. testing/nxdart
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying downloadable files... [100%]
components/drivers/special/usbmonitor_wireshark_linux_example_adb.pcapng
copying static files... done
copying extra files... done
done
writing output... [ 40%] applications/wireless/wapi/index ..
components/drivers/character/analog/dac/mcp47x6/in
writing output... [ 42%]
components/drivers/character/analog/dac/mcp48xx/index ..
components/drivers/character/
writing output... [ 68%] platforms/arm/eoss3/boards/quickfeather/index ..
platforms/arm/imxrt/boards/imxrt1060-
writing output... [ 69%] platforms/arm/imxrt/boards/imxrt1064-evk/index ..
platforms/arm/lpc17xx/boards/pnev518
writing output... [ 73%] platforms/arm/mx8mp/boards/verdin-mx8mp/index ..
platforms/arm/phy62xx/boards/phy6222/
writing output... [ 76%] platforms/arm/s32k1xx/boards/ucans32k146/index ..
platforms/arm/samd2l2/boards/saml21-
writing output... [ 77%] platforms/arm/samd2l2/boards/xiao-seeeduino/index
.. platforms/arm/stm32f1/boards/shen
writing output... [ 79%] platforms/arm/stm32f1/boards/stm3210e-eval/index ..
platforms/arm/stm32f4/boards/nucle
writing output... [ 81%] platforms/arm/stm32f4/boards/nucleo-f412zg/index ..
platforms/arm/stm32g0/boards/nucle
writing output... [ 82%] platforms/arm/stm32g0/boards/nucleo-g071rb/index ..
platforms/arm/stm32l0/boards/nucle
writing output... [ 92%]
platforms/risc-v/esp32p4/boards/esp32p4-function-ev-board/index ..
platforms/risc-v/rv
writing output... [100%] reference/user/11_network .. testing/nxdart
generating indices... genindex done
writing additional pages... search done
copying images... [ 54%]
platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit-rust-1/esp32c3-devkit-rus
copying images... [ 55%]
platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit/ESP32-C3-DevKitC-02-v1.1.
copying images... [ 55%]
platforms/risc-v/esp32c3-legacy/boards/esp32c3-legacy-devkit/ESP32-C3-DevKitM-1-v
Re: [PR] doc: Migrating the rest of documentation from cwiki. [nuttx]
cederom commented on PR #18970: URL: https://github.com/apache/nuttx/pull/18970#issuecomment-4551225778 Uh oh, some doc build errors, sorry, need to take a nap and will fix in a free moment.. I updated sphinx on my local machine because it works a lot faster.. looks like syntax also changed a bit there was no complains on my local build. Also in a free moment need to update sphinx on our repo to build faster :-) -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
[PR] doc: Migrating the rest of documentation from cwiki. [nuttx]
cederom opened a new pull request, #18970:
URL: https://github.com/apache/nuttx/pull/18970
## Summary
* This completes task list in https://github.com/apache/nuttx/issues/11127.
* This preserves selected content from cwiki and moves it to new docs.
* Most pages are simple copy-paste with a simple RST formatting updates,
with minor updates.
* Content update / reorganization will follow later on when needed.
* Files added (or updated title from cwiki -> current docs):
* Documentation/implementation:
* index.
* cancellation_points.
* Asynchronous vs. Synchronous Context Switches -> context_switches.rst.
* ARMv7-M Hardfaults, SVCALL, and Debuggers -> hardfatuls.rst.
* chip.h FAQ -> chip_h.rst.
* Debug Output (SYSLOG) Issues -> syslog.rst.
* Detaching File Descriptors -> file_descriptors.rst.
* device_nodes.rst.
* Dynamic Clocking -> power_management.rst.
* ENOTTY ioctl() Return Value -> ioctl.rst.
* memory_configurations.rst.
* kernel_modules_vs_shared_libraries.rst.
* NAKing USB OUT/IN Tokens -> usb.rst.
* naming_arch_mcu_board_interfaces.rst.
* naming_os_internals.rst.
* nuttx_tasking.rst.
* oneshot_timers_and_cpu_load.rst.
* nuttx_initialization_sequence.rst.
* short_time_delays.rst.
* Signal Handler Tour -> signal_handlers.rst.
* smp.rst.
* syslog.rst.
* Task Exit Sequence -> nuttx_tasking.rst.
* tasks_vs_threads.rst.
* tls.rst.
* tickless_os.rst.
* Why Can't Kernel Threads Have pthreads ->
kernel_threads_vs_pthreads.rst.
* Documentation/components/filesystem:
* smartfs.rst.
## Impact
Documentation parts from cwiki
(https://cwiki.apache.org/confluence/display/NUTTX/Wiki) is preserved into our
new in-tree sphinx based documentation.
## Testing
```
% uname -a
FreeBSD hexagon 14.4-RELEASE-p5 FreeBSD 14.4-RELEASE-p5 GENERIC amd64
% cd nuttx.git/Documentation
% pipenv shell
% sphinx-autobuild --delay=15 . /tmp/nuttx/doc/html
[sphinx-autobuild] > python -m sphinx build . /tmp/nuttx/doc/html
Running Sphinx v7.3.7
loading pickled environment... done
myst v3.0.1: MdParserConfig(commonmark_only=False, gfm_only=False,
enable_extensions=set(), disable_syntax=[], all_links_external=False,
links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'),
ref_domains=None, fence_as_directive=set(), number_code_blocks=[],
title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={},
footnote_transition=True, words_per_minute=200, substitutions={},
linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True,
dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True,
mathjax_classes='tex2jax_process|mathjax_process|math|output_area',
enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
Tags updated
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 146 source files that are out of date
updating environment: 0 added, 146 changed, 0 removed
reading sources... [100%] _tags/wifi
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying downloadable files... [ 25%]
components/drivers/special/usbmonitor_wireshark_l
copying downloadable files... [100%]
platforms/xtensa/esp32s2/boards/esp32s2-saola-1/tone.wav
copying static files... done
copying extra files... done
done
writing output... [100%] index
generating indices... genindex done
writing additional pages... search done
dumping search index in English (code: en)... done
dumping object inventory... done
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\. c:.*::
net_driver_s'.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*sigaction.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*open.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*close.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*read.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*write.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*ioctl.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*mmap.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*poll.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*dup.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*rewinddir.*
WARNING:root:Unused expression: .*Duplicate C declaration.*\n.*'\.\.
c:.*::.*bind.*
WARNING:root:Unused expression: .
