Feature/remove toc not included warnings#82
Conversation
| :maxdepth: 2 | ||
| :caption: Echo Test Build Information | ||
|
|
||
| ../openamp-system-reference/examples/legacy_apps/examples/echo/README No newline at end of file |
There was a problem hiding this comment.
I wonder if we should not rework the readme files
../openamp-system-reference/examples/legacy_apps/README should perhaps describe how to set the compilation environment , and we should remove the Run application on a Linux PC chapter.
Link to openamp-system-reference/examples/legacy_apps/README in ../openamp-system-reference/examples/legacy_apps/examples/echo/README seems broken.
There was a problem hiding this comment.
Yes, adjusting readme files to suit inclusion into openamp docs would make sense.
Yes, as mentioned in the PR summary (second last paragraph) some links are broken as they do not use sphinx references. I did not fix those for this draft pull request as was just showing how the toc not included warnings can be corrected as example before proceeding to address all as there are quite some.
sipke
force-pushed
the
feature/remove-toc-not-included-warnings
branch
2 times, most recently
from
7a70774 to
1530e3e
Compare
|
Reworked this slightly.
@arnopo if this is the right direction to start cross linking build info between repositories and readthedocs let me know and I will repeat for other demos. |
Look to me the good direction. |
there are submodules which have document files just for the repository, so provide a toctree of hidden files so the warning about missing file in toc is suppressed. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
for ease of reference to build information in the submodule add a content table to the echo example documentation in the openamp-system-reference. This will also remove the warning that the file is not in a toc. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Add the examples/legacy_apps/readme from the openamp-system-reference repository to the reference board page as the build information applies to all applications rather than any one demo from legacy_apps. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
for ease of reference to build information in the submodule add a content table to the example documentation in the openamp-system-reference. This will also remove the warning that the file is not in a toc. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
for ease of reference to build information in the submodule add a content table to the example documentation in the openamp-system-reference. This will also remove the warning that the file is not in a toc. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
for ease of reference to build information in the submodule add a content table to the example documentation in the openamp-system-reference. This will also remove the warning that the file is not in a toc. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
the readthedocs demo is for linux interprocess example of rpc, but there is a remote side app as well in reference repository so add reference to it at the end of the demo for those wishing to try it.
Integrated the openamp-system-reference repository readme pages with amd specific setup and build information. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
These readme pages do not have a description page in readthedocs currently, so suppress these until decided whether to add somewhere in readthedocs where they can be integrated. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sipke
force-pushed
the
feature/remove-toc-not-included-warnings
branch
2 times, most recently
from
05bdfa2 to
5362021
Compare
|
Integrated most of the openamp-system-reference examples. Will use this pull request for that repository only and use new PRs for other submodule repositories. The second to last commit shows the examples for which currently there is no corresponding documentation in openamp-docs. I propose if these should have then we create issues for each and address independently. openamp-system-reference/examples/legacy_apps/examples/nocopy_echo/README Unfortunately I noticed when adding those as :hidden in the TOC, they show up on the left hand navigation bar, so ignore that hiccup for now. |
by default all toc entries via toctree:: are included into the sidebar, including hidden ones which spams the menu, so set includehidden to false in the theme options. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Integrate the build and reference documentation from the hypervisorless virtio repository into the demo. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
the open-amp and libmetal repository doxygen documentation, including readme files are included via the reference link in the navigation bar on the left, so list them as hidden in the main index. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
the readme file for openamp-docs is only for how to generate these docs so hide it to avoid invalid warning that it is missing from table of contents. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Proposing to include these maintainers files through the reference link in the navigation bar on the left, whence we can hid them from the table of contents in the openamp-docs repository. Two additional pull requests would be made to open-amp and libmetal to support this. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
hide from table of contenst the readme files in the lopper repository which detail what is in that repository and how to test rather than are actual documentation. This removes the toc.notincluded warning as that content isn't inside any readthedocs documentation. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
to enable the integration of the documentation in the lopper repository rearrange the files and tocs to make lopper a top leavel tool and add the repository documentation files as table of content entries. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
remove non existent openamp-docs/README as it is already in there as README at base directory. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sipke
force-pushed
the
feature/remove-toc-not-included-warnings
branch
from
5362021 to
e30237f
Compare
This is part of draft pull request. Do not merge. provide gitmodule reference from sipke's forked repository to show the openamp-system-reference readme integrations into readthedocs. will delete once reviewed and submit PR as not draft. Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sipke
force-pushed
the
feature/remove-toc-not-included-warnings
branch
from
e30237f to
57fb88f
Compare
|
Integrated documents from all sub repositories. |
arnopo
left a comment
arnopo
left a comment
There was a problem hiding this comment.
I haven’t spent much time on the review since it is still in draft, but the rework seems pretty good to me.
Pleas find 2 comments .
|
|
||
| Lopper | ||
| ------ | ||
|
|
There was a problem hiding this comment.
Regarding https://openamp--82.org.readthedocs.build/en/82/tools/index.html#
the chapter lopper is displayed twice
| openamp-docs/README | ||
| open-amp/.github/actions/build_ci/README | ||
| open-amp/README | ||
| open-amp/MAINTAINERS |
There was a problem hiding this comment.
generate page is empty ?
_m_a_i_n_t_a_i_n_e_r_s_8md.html
2 participants
This PR is not complete and provided as an example follow on for PR #81.
All git submodules currently have files not included in openamp-docs, which results in warning
WARNING: document isn't included in any toctree [toc.not_included]
Most of the files could be integrated into the documentations, with first example given including the "build" information for the Echo Example of the openamp-system-reference.
There are some files harder to integrate and for those recommendation is to filter them out using the toc :hidden: feature which suppresses the warning.
Note, that some changes will be needed for files in submodules also as some of the links there are relative hyperlinks, rather than sphinx references. You will notice under Echo Test Build Information -> Compilation, the link to README.md does not work currently, as it is a relative hyperlink rather than sphinx reference. Solvable, just not done yet in this proposal.
If the proposal is acceptable, can proceed to eliminate toc.not_included warnings in one of the above two methods.