Skip to content

Commit e8e7733

Browse files
Merge branch 'ccrouzet/gh-532-built-in-doc' into 'main'
Document Built-Ins Scope (GH-532) See merge request omniverse/warp!1296
2 parents 834fc61 + c4fd69c commit e8e7733

File tree

6 files changed

+2723
-57
lines changed

6 files changed

+2723
-57
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,9 @@
5555
- Rename the internal function `wp.types.type_length()` to `type_size()`.
5656
- Lift the exact version requirement in `omni.warp` towards `omni.warp.core`
5757
([GH-702](https://github.com/NVIDIA/warp/issues/702)).
58+
- Rename the “Kernel Reference” documentation page to “Built-Ins Reference”, with each built-in now having
59+
annotations to denote whether they are accessible only from the kernel scope or also from the Python runtime scope
60+
([GH-532](https://github.com/NVIDIA/warp/issues/532)).
5861

5962
### Fixed
6063

docs/_static/custom.css

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
section#built-ins-reference dl.function table.hlist tbody
2+
{
3+
display: table-cell;
4+
}
5+
6+
section#built-ins-reference dl.function table.hlist td
7+
{
8+
padding: 0;
9+
}
10+
11+
section#built-ins-reference dl.function table.hlist ul
12+
{
13+
list-style-type: none;
14+
padding: 0;
15+
}
16+
17+
section#built-ins-reference dl.function table.hlist li
18+
{
19+
border-color: var(--pst-color-border);
20+
border-radius: 1rem;
21+
border-style: solid;
22+
border-width: 2px;
23+
font-size: 0.75rem;
24+
margin: 0 0.25rem;
25+
padding: 0 0.25rem;
26+
}

docs/conf.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,10 @@ def linkcode_resolve(domain, info):
153153
html_theme = "nvidia_sphinx_theme"
154154
html_title = f"Warp {version}"
155155
html_show_sphinx = False
156+
html_static_path = ["_static"]
157+
html_css_files = [
158+
"custom.css",
159+
]
156160
html_theme_options = {
157161
"copyright_override": {"start": 2022},
158162
"pygments_light_style": "tango",

0 commit comments

Comments
 (0)