By the way, my earlier suggestion, putting arch- and board-related docs in
a directory hierarchy that parallels that of the sources, so, for example:
stm32f4discovery is in boards/arm/stm32/stm32f4discovery/
its docs would be in
Documentation/boards/arm/stm32/stm32f4discovery/board.rst
So it
A symlink might be better than hundreds of one-line README files. How will
that affect Windows though? Not all versions of Windows support symlinks
(though Windows 10 does since some time ago).
Cheers
Nathan
On Thu, Jan 19, 2023 at 2:18 PM Alan C. Assis wrote:
> Thank you Brennan,
>
> Yes, I
Thank you Brennan,
Yes, I understood the point. Maybe an option could be keep the board
documentation at
Documentation/platforms/arm/stm32/boards/stm32f4discovery/ and put a
symbolic link at boards/xxx/yyy/boardname/README.rst point to it.
Or just use a boards/xxx/yyy/boardname/README.txt with a
not sure but there may be doxygen or sphinx like utilities to geneate doc
right out of the source code?
for instance here is browsable and single page html and pdf other formats
possible:
https://kivy.org/doc/stable/
sphinx seems more modern and versatile than doxygen also this sphinx
docstrings
On Wed, Jan 18, 2023, 7:14 PM Nathan Hartman
wrote:
> Is there a way to facilitate both?
>
> That is, on the one hand, centralize the documentation in the nuttx
> repository's Documentation directory so it can be modern and avoid
> duplication, while at the same time facilitating the terminal
Is there a way to facilitate both?
That is, on the one hand, centralize the documentation in the nuttx
repository's Documentation directory so it can be modern and avoid
duplication, while at the same time facilitating the terminal usage
suggested by Alan?
For example, is it possible to compile
I would like to just move to the documentation section. There is way too
much duplicate out of date common information in the existing readme. The
new documentation has the ability to actually link things.
Also CI is smart and will only build documentation and not all of the
builds if you make
Hi Everyone,
As some have noticed some boards still have their README.txt in their
original places:
boards/arm/stm32/stm32f4discovery/README.txt
boards/arm/rp2040/raspberrypi-pico/README.txt
boards/x86_64/intel64/qemu-intel64/README.txt
boards/risc-v/qemu-rv/rv-virt/README.txt
