[DOCS] Various improvements (#224)
- Added docstr for autotune, Config, heuristics - Added docstr for atomics - Hiding internal _builder argument used for built-in language primitives - Re-factor docstr to use common templates between similar functions.
This commit is contained in:
10
docs/conf.py
10
docs/conf.py
@@ -24,11 +24,20 @@
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
|
||||
|
||||
|
||||
def process_sig(app, what, name, obj, options, signature, return_annotation):
|
||||
if signature and '_builder' in signature:
|
||||
signature = signature.split('_builder')[0] + ")"
|
||||
return (signature, return_annotation)
|
||||
|
||||
def setup(app):
|
||||
"""Customize function args retrieving to get args under decorator."""
|
||||
import sphinx
|
||||
import triton
|
||||
|
||||
app.connect("autodoc-process-signature", process_sig)
|
||||
|
||||
def forward_jit_fn(func):
|
||||
old = func
|
||||
|
||||
@@ -39,6 +48,7 @@ def setup(app):
|
||||
|
||||
return wrapped
|
||||
|
||||
|
||||
old_documenter = sphinx.ext.autosummary.get_documenter
|
||||
|
||||
def documenter(app, obj, parent):
|
||||
|
@@ -98,6 +98,18 @@ Reduction Ops
|
||||
min
|
||||
sum
|
||||
|
||||
Atomic Ops
|
||||
---------------
|
||||
|
||||
.. autosummary::
|
||||
:toctree: generated
|
||||
:nosignatures:
|
||||
|
||||
atomic_cas
|
||||
atomic_add
|
||||
atomic_max
|
||||
atomic_min
|
||||
|
||||
|
||||
Comparison ops
|
||||
---------------
|
||||
|
@@ -7,4 +7,7 @@ triton
|
||||
:toctree: generated
|
||||
:nosignatures:
|
||||
|
||||
jit
|
||||
jit
|
||||
autotune
|
||||
heuristics
|
||||
Config
|
Reference in New Issue
Block a user