Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/pages/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="refresh" content="0; url=https://rocm.docs.amd.com/projects/atom/en/latest/">
Comment on lines +1 to +5
<link rel="canonical" href="https://rocm.docs.amd.com/projects/atom/en/latest/">
<title>ATOM documentation — redirecting</title>
<script>window.location.replace("https://rocm.docs.amd.com/projects/atom/en/latest/");</script>
</head>
<body>
<p>The ATOM documentation has moved.
If you are not redirected automatically,
<a href="https://rocm.docs.amd.com/projects/atom/en/latest/">click here</a>.
</p>
</body>
</html>
75 changes: 0 additions & 75 deletions .github/workflows/docs.yml

This file was deleted.

18 changes: 18 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

version: 2

sphinx:
configuration: docs/conf.py

formats: []

python:
install:
- requirements: docs/sphinx/requirements.txt
Comment thread
peterjunpark marked this conversation as resolved.
Resolved

build:
os: ubuntu-24.04
tools:
python: "3.12"
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ lm_eval --model local-completions \

## 📚 Documentation

**Full documentation: [rocm.github.io/ATOM/docs](https://rocm.github.io/ATOM/docs)**
**Full documentation: [rocm.docs.amd.com/projects/atom/en/latest/](https://rocm.docs.amd.com/projects/atom/en/latest/)**

| Topic | Description | Guide |
|---|---|---|
Expand Down
2 changes: 2 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
_build/
sphinx/_toc.yml
174 changes: 0 additions & 174 deletions docs/DOCUMENTATION_AUDIT_REPORT.md

This file was deleted.

Empty file removed docs/_static/.gitkeep
Empty file.
63 changes: 27 additions & 36 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,63 +7,54 @@

# -- Project information -----------------------------------------------------
project = "ATOM"
copyright = "2026, AMD"
author = "AMD ROCm Team"
release = "0.1.0"
copyright = "Copyright (c) %Y Advanced Micro Devices, Inc. All rights reserved."
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
author = "Advanced Micro Devices, Inc."
version = "0.1.0"
release = version

# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.autodoc",
"rocm_docs",
"sphinx.ext.napoleon",
"sphinx.ext.viewcode",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinx_rtd_theme",
"myst_parser",
# enabled by rocm_docs:
# "sphinx.ext.autodoc",
# "sphinx.ext.mathjax",
# "myst_parser",
]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
external_toc_path = "./sphinx/_toc.yml"
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved

source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}
templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "DOCUMENTATION_AUDIT_REPORT.md"]

# -- Options for HTML output -------------------------------------------------
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

html_theme = "rocm_docs_theme"
html_theme_options = {
"logo_only": False,
"display_version": True,
"prev_next_buttons_location": "bottom",
"style_external_links": False,
"style_nav_header_background": "#C00000", # AMD Red
"collapse_navigation": False,
"sticky_navigation": True,
"navigation_depth": 4,
"includehidden": True,
"titles_only": False,
"flavor": "ai-ecosystem",
"link_main_doc": True,
"repository_url": "https://github.com/ROCm/ATOM",
"use_repository_button": True,
"use_issues_button": True,
"use_download_button": True,
}

html_logo = "assets/atom_logo.png"
html_favicon = None

# -- Extension configuration -------------------------------------------------

# Publish the llms.txt index at the docs site root and let
# rocm-docs-core generate llms-full.txt after each build (the llms.txt standard,
# https://llmstxt.org/). See the rocm-docs-core guide:
# https://rocm.docs.amd.com/projects/rocm-docs-core/en/latest/user_guide/llms.html
rocm_docs_generate_llms = True

# Napoleon settings
napoleon_google_docstring = True
napoleon_numpy_docstring = True

# Intersphinx configuration
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"torch": ("https://pytorch.org/docs/stable/", None),
}

# MyST parser settings
myst_enable_extensions = [
myst_enable_extensions = {
"colon_fence",
"deflist",
]
}
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment thread
peterjunpark marked this conversation as resolved.
Resolved
Comment on lines +57 to +60
Loading
Loading