File: index.md

package info (click to toggle)
rocm-docs-core 1.23.0-5
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 2,632 kB
  • sloc: python: 1,960; sh: 160; javascript: 152; cpp: 29; makefile: 27
file content (50 lines) | stat: -rw-r--r-- 1,375 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
---
myst:
    html_meta:
        "description": "A collection of utilities, styling, scripts, and additional HTML content common to all ROCm project documentation"
        "keywords": "ROCm documentation configuration, ROCm documentation customization, ROCm documentation tool, ROCm docs core developer guide"
---

# ROCm Docs Core

ROCm Docs Core is a collection of utilities, styling, scripts and additional
HTML content common to all ROCm projects' documentation.

ROCm Docs Core is distributed as a pip package available from PyPi as
[rocm-docs-core](https://pypi.org/project/rocm-docs-core/)

## Overview

::::{grid} 1 1 2 2
:gutter: 1

:::{grid-item-card} {doc}`User Guide</user_guide/user_guide>`
:class-body: rocm-card-banner rocm-hue-1

- {doc}`/user_guide/spellcheck`
- {doc}`/user_guide/linting`
- {doc}`/user_guide/linking`
- {doc}`/user_guide/article_info`
- {doc}`/user_guide/doxygen_integration`

:::

:::{grid-item-card} {doc}`Developer Guide</developer_guide/developer_guide>`
:class-body: rocm-card-banner rocm-hue-6

- {doc}`/developer_guide/just`
- {doc}`/developer_guide/python_linting`
- {doc}`/developer_guide/commitizen`
- {doc}`/developer_guide/projects_yaml`
- {doc}`/developer_guide/dependabot`

:::

:::{grid-item-card} Demo Doxygen Documentation Integration
:class-body: rocm-card-banner rocm-hue-12

- {doc}`/demo/doxygen/html/index`

:::

::::