Update _toc.yml.in #2587
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,34 @@ | ||
| # Anywhere {branch} is used, the branch name will be substituted. | ||
| # These comments will also be removed. | ||
| defaults: | ||
| numbered: False | ||
| maxdepth: 7 | ||
| root: index | ||
| subtrees: | ||
| - caption: What is MIOpen? | ||
|
There was a problem hiding this comment. this should not be a heading. it should be an intro page that describes the project. There was a problem hiding this comment. We are still discussing the content for the Intro page. For now, we have reorganized the ToC on what's available and accurate. We have also removed the reference to release notes, as it is obsolete. There was a problem hiding this comment. then we need to wait until we have a page to link to. It's confusing to have a heading represent a placeholder for a future page. A heading (='caption' in the toc) should only be there to represent pages that fit into that heading. There was a problem hiding this comment. That's a decision we must make. Working with the team. There was a problem hiding this comment. you can use the README file to get a little general info for a 'What is ..?' page until the team gets a chance to add to it. this page doesn't need to super long or elaborate, just has to describe what the project is/does. There was a problem hiding this comment. Thanks, Lisa. Thanks so much for your help and comments. |
||
| entries: | ||
| - file: find_and_immediate.rst | ||
| - file: finddb.rst | ||
| - file: cache.rst | ||
| - file: perfdatabase.rst | ||
| - file: Getting_Started_FusionAPI.rst | ||
| - file: DebugAndLogging.rst | ||
| - file: MI200AlternateImplementation.rst | ||
| - file: MIOpen_Porting_Guide.rst | ||
| - file: citation.rst | ||
| - caption: Quick-start | ||
| entries: | ||
| - file: reference/install.rst | ||
| - file: reference/embed.rst | ||
| - file: reference/driver.rst | ||
| - caption: API reference | ||
| entries: | ||
| - file: reference/apireference.rst | ||
|
There was a problem hiding this comment. the files here in the TOC are relative to the for this to render correctly, |
||
| title: API library | ||
| - file: tutorials/index.rst | ||
| - caption: Tutorials | ||
| entries: | ||
| - file: tutorials/install.rst | ||
| - file: tutorials/embed.rst | ||
| - file: tutorials/driver.rst | ||
| title: Installing and building MIOpen | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
where is the API ref heading? you seem to have removed the entire former API ref section and there is no organization to the existing pages
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://github.com/ROCmSoftwarePlatform/MIOpen/blob/Rmalavally-patch-1/docs/sphinx/_toc.yml.in
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
look at the build--it's not rendering, so you need to fix the code.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep. It's a work in progress. Won't render yet.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
you haven't added any of the Doxygen content (=the API ref)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Doxygen builds content automatically from the header files (which contains the code/text/content for the API). The team does does not supply the API textual content. This content is build into the "Doxygen" folder--this is what you need to include in the toc in order to incorporate the API ref.