Skip to content

Adding the docs folder and corresponding sphinx build collateral.#15

Merged
radhaksri merged 6 commits into
ROCm:mainfrom
im-AbhiP:crt-docs
May 13, 2025
Merged

Adding the docs folder and corresponding sphinx build collateral.#15
radhaksri merged 6 commits into
ROCm:mainfrom
im-AbhiP:crt-docs

Conversation

@im-AbhiP
Copy link
Copy Markdown
Contributor

@im-AbhiP im-AbhiP commented May 2, 2025

No description provided.

@im-AbhiP im-AbhiP added the documentation Improvements or additions to documentation label May 2, 2025
@im-AbhiP im-AbhiP self-assigned this May 2, 2025
Comment thread docs/sphinx/_toc.yml Outdated
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You don't need to check in this file. It is autogenerated.

Comment thread docs/sphinx/_toc.yml.in
- caption: Tools
entries:
- file: container-runtime/index.rst
title: Container Runtime
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All the rst files should be in the toc

Comment thread docs/conf.py
author = "Advanced Micro Devices, Inc."
copyright = "Copyright (c) 2024 Advanced Micro Devices, Inc. All rights reserved."

# Supported linux version numbers
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like the automation you've done here.

Comment thread docs/conf.py Outdated
Copy link
Copy Markdown
Member

@saadrahim saadrahim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are missing a .readthedocs.yaml file in the project root directory. Please see the template repository. Also, the CI is now running, so you can see the success or failure of the documentation build.

@im-AbhiP im-AbhiP requested review from ask-mi and farshadghodsian May 6, 2025 08:05
Comment thread docs/index.md
"keywords": "AMD, ROCm, Container Runtime, GPU, HPC, Machine Learning"
---

# AMD ROCm Container Runtime Documentation
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# AMD ROCm Container Runtime Documentation
# AMD Container Runtime Documentation

Copy link
Copy Markdown

@ask-mi ask-mi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@radhaksri radhaksri merged commit e020de1 into ROCm:main May 13, 2025
1 check passed
@im-AbhiP im-AbhiP deleted the crt-docs branch May 15, 2025 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants