Hipsparseltdocs reorg #101
Conversation
Add install folder
create conceptual folder
create how to folder
delete from reference
Updated index with new template
updated yml file
Rmalavally
requested review from
a team,
vin-huang,
jichangjichang,
hcman2 and
imcarsonliao
as code owners
There was a problem hiding this comment.
Hi Roopa, I am not sure I agree that hipSPARSELt data types are conceptual. It seems like that content is reference material.
The How to "Use hipSPARSELt" topic appears in the Index but does not appear in the TOC. Also, it seems to be more about how to port from CUDA instead of how to use hipSPARSELt?
Otherwise it looks fine to me.
Thanks, Randy, for your feedback. I wondered about data types, but put it in conceptual. I think it must be a separate link, neither in conceptual nor in API Reference. But moved it to API for now. Please refresh and check. I had corrected the How to previously. |
docs/index.rst
Outdated
|
|
||
| To contribute to the documentation refer to | ||
| `Contributing to ROCm <https://rocm.docs.amd.com/en/latest/contribute/contributing.html>`_. | ||
| * :doc:`Device stream manage <./conceptual/device-stream-manage>` |
There was a problem hiding this comment.
Device & stream management??
There was a problem hiding this comment.
(the title in the doc is "HIP device and stream management")
|
There are linting issues that need to be fixed. |
| * :doc:`Quick-start <./install/quick-start>` | ||
| * :doc:`hipSPARSELt installation <./install/linux>` | ||
|
|
||
| .. grid-item-card:: API reference |
There was a problem hiding this comment.
this list is in a different order than in the toc
There was a problem hiding this comment.
Here's what i have:
.. grid:: 2
:gutter: 3
.. grid-item-card:: Install
* :doc:`Quick-start <./install/quick-start>`
* :doc:`Installation guide <./install/linux>`
.. grid-item-card:: API reference
* :doc:`Supported functions <./reference/supported-functions>`
* :doc:`Data type support <./conceptual/data-type-support>`
* :doc:`API library <../doxygen/html/index>`
.. grid-item-card:: How to
* :doc:`Port from CUDA to hipSPARSELt <./how to/porting>`
.. grid-item-card:: Conceptual
* :doc:`HIP device and stream management <./conceptual/device-stream-manage>`
* :doc:`Storage formats <./conceptual/storage-format>`
There was a problem hiding this comment.
yes, I can see what you have in the file. The order of the API ref content differs from the order in the TOC.
There was a problem hiding this comment.
yes, I can see what you have in the file. The order of the API ref content differs from the order in the TOC.
Same order in the .yml file. Rebuilt just now.
-
caption: Conceptual
entries:- file: conceptual/device-stream-manage.rst
title: HIP device & stream management - file: conceptual/storage-format.rst
title: Storage formats
- file: conceptual/device-stream-manage.rst
-
caption: How to
entries:- file: how to/porting
title: Port from CUDA to hipSPARSELt
- file: how to/porting
-
caption: API Reference
entries:- file: reference/supported-functions.rst
title: Supported functions - file: conceptual/data-type-support.rst
title: Data type support - file: doxygen/html/index
title: API library
- file: reference/supported-functions.rst
There was a problem hiding this comment.
yes, I can see what you have in the file. The order of the API ref content differs from the order in the TOC.
Same order in the .yml file. Rebuilt again.
caption: Conceptual
entries:
- file: conceptual/device-stream-manage.rst
title: HIP device & stream management- file: conceptual/storage-format.rst
title: Storage formatscaption: How to
entries:
- file: how to/porting
title: Port from CUDA to hipSPARSELtcaption: API Reference
entries:
- file: reference/supported-functions.rst
title: Supported functions- file: conceptual/data-type-support.rst
title: Data type support- file: doxygen/html/index
title: API library
There was a problem hiding this comment.
It's in the reference folder,
https://github.com/Rmalavally/hipSPARSELt/tree/hipsparseltdocs_reorg/docs/reference
There was a problem hiding this comment.
Only two files in the conceptual folder
https://github.com/Rmalavally/hipSPARSELt/tree/hipsparseltdocs_reorg/docs/conceptual
There was a problem hiding this comment.
Here's what index.rst looks like,
Install
Quick-start <./install/quick-start>
Installation guide <./install/linux>
API reference
Supported functions <./reference/supported-functions>
Data type support <./reference/data-type-support>
API library <../doxygen/html/index>
How to
Port from CUDA to hipSPARSELt <./how to/porting>
Conceptual
HIP device and stream management <./conceptual/device-stream-manage>
Storage formats <./conceptual/storage-format>
To contribute to the documentation, refer to Contributing to ROCm.
You can find licensing information on the Licensing page.
There was a problem hiding this comment.
Data type support.rst was in both directories. Removed it from conceptual.
There was a problem hiding this comment.
(you don't need to paste file contents into comments--I can easily see them within the files themselves)
Yeah. Looking into the issues today. |
| @@ -5,7 +5,7 @@ | |||
| .. _storage-format: | |||
|
|
|||
| ******************************** | |||
| Storage format | |||
| Storage formats | |||
There was a problem hiding this comment.
if they only use one storage format (which they seem to), this should remain singular
There was a problem hiding this comment.
The original yml file in develop has 'storage formats', so made changes in the latest version to reflect that.
https://github.com/Rmalavally/hipSPARSELt/blob/develop/docs/sphinx/_toc.yml.in
Singular makes sense.
There was a problem hiding this comment.
The original yml file in develop has 'storage formats', so made changes in the latest version to reflect that.
https://github.com/Rmalavally/hipSPARSELt/blob/develop/docs/sphinx/_toc.yml.in
Singular makes sense.
- file: reference/storage-format.rst
title: Storage formats
Change Storage formats to Storage format
Change Storage formats to Storage format
samjwu
added
documentation
No description provided.