Update _toc.yml.in #2587
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,24 +1,44 @@ | ||
| # Anywhere {branch} is used, the branch name will be substituted. | ||
| # These comments will also be removed. | ||
| defaults: | ||
| numbered: False | ||
| maxdepth: 7 | ||
| root: index | ||
| caption: What is MIOpen? | ||
samjwu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| subtrees: | ||
| - 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 | ||
samjwu marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| - file: reference/install.rst | ||
| - file: reference/embed.rst | ||
| - file: reference/driver.rst | ||
|
|
||
| caption: API reference | ||
| subtrees: | ||
| - entries: | ||
| - file: reference/apireference.rst | ||
|
There was a problem hiding this comment. You're referencing a lot of files/folders that don't exit...and need to include the API ref from the doxygen folder (see my previous comment). There was a problem hiding this comment. Bibek and I added the API ref from the Doxygen folder. @bghimireamd Please advise. There was a problem hiding this comment. Exit? or Exist? We have reused all existing and original files. Sam recommended we create the appropriate folders, and as suggested, we used hipSPARSElt as the template. Should we remove the titles and keep it simple for 6.0? There was a problem hiding this comment. that was a typo: I meant exist. |
||
| title: API library | ||
|
|
||
| - file: tutorials/index.rst | ||
| title: Tutorials | ||
| subtrees: | ||
| - entries: | ||
| - file: tutorials/install.rst | ||
| - file: tutorials/embed.rst | ||
| - file: tutorials/driver.rst | ||
| title: Installing and building MIOpen | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.