project:max11205pmb1: Added README documentation for MAX11205PMB1. #2741
Conversation
Added the README file for the MAX11205PMB1 project. Modified the sphinx projects_doc.rst file to add the corresponding source. Signed-off-by: Carl Ian Gamutan <Carlian.Gamutan@analog.com>
Carlian275
requested review from
CiprianRegus,
amiclaus,
buha,
danmois,
dbogdan and
rbolboac
as code owners
Carlian275
changed the title
There was a problem hiding this comment.
Hi Carl,
Some comments, if you have questions, please feel free to ask.
About recursively updating, I had something similar at
analogdevicesinc/documentation#56
to change local references to cross-repo references
find . -type f -name "*.rst" -exec sed -i -E 's|(^\|[[:space:]]):ref:`([^<]+) <kuiper sdcard>`|\1:external+adi-kuiper-gen:doc:`\2 <use-kuiper-image>`|g' {} \;
find . -type f -name "*.rst" -exec sed -i -E 's|(^\|[[:space:]]):ref:`(kuiper sdcard`|\1:external+adi-kuiper-gen:doc:`use-kuiper-image`|g' {} \;
You could do something similar for the hard-coded urls
| @@ -0,0 +1,176 @@ | |||
| MAX11205PMB1 no-OS Example Project | |||
| ================================== | |||
|
|
|||
There was a problem hiding this comment.
[Must]
| .. no-os-doxygen:: |
every doc page that contains a doxygen doc should contain the .. no-os-doxygen:: directive.
It will auto create a
"See projects/ad405x (doxygen) for the Doxygen documentation."
automatically resolving the obnoxious doxygen generated url dir_f05c786dc4c770a23b7a3f54fd92d3b6.html.
Please do the same for all pages.
| ------------------------ | ||
|
|
||
| The initialization data used in the examples is taken out from: | ||
| `Project Common Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/max11205pmb1/src/common>`__ |
There was a problem hiding this comment.
[Suggestion]
This can be shortened as
| `Project Common Data Path <https://github.com/analogdevicesinc/no-OS/tree/main/projects/max11205pmb1/src/common>`__ | |
| :git-no-OS:`projects/max11205pmb1/src/common` |
but it is a suggestion, if the other pages are not using, I wouldn't start bothering right now, instead, recursively replace in a future opportunity.
https://analogdevicesinc.github.io/doctools/docs_guidelines/roles.html#git
| customizable buffer sizes. | ||
|
|
||
| If you are not familiar with ADI IIO Application, please take a look at: | ||
| `IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`__ |
There was a problem hiding this comment.
[Suggestion]
| `IIO No-OS <https://wiki.analog.com/resources/tools-software/no-os-software/iio>`__ | |
| :dokuwiki:`IIO No-OS <resources/tools-software/no-os-software/iio>` |
https://analogdevicesinc.github.io/doctools/docs_guidelines/roles.html#dokuwiki
But I don't understand why is this being linked still, there is no github.io equivalent page?
2 participants
Added the README file for the MAX11205PMB1 project.
Modified the sphinx projects_doc.rst file to add the corresponding source.
PR Type
PR Checklist