[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:
Philippe Tillet
2021-08-18 11:15:53 -07:00
committed by GitHub
parent 226fde6ea1
commit f26a48a3b4
6 changed files with 275 additions and 222 deletions

View File

@@ -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):