Configs are now automatically documented using in source annotations

IntelPython · Mar 29, 2024 · 017b092 · 017b092
1 parent a7867ce
commit 017b092
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 67 deletions.
diff --git a/docs/_templates/autoapi/python/module.rst b/docs/_templates/autoapi/python/module.rst
@@ -1,8 +1,11 @@
 {% import 'macros.rst' as macros %}
 
 {% if not obj.display %}
+{% if not "config" in obj.name %}
+
 :orphan:
 
+{% endif %}
 {% endif %}
 {{ obj.name }}
 {{ "=" * obj.name|length }}
@@ -57,13 +60,14 @@ Submodules
 {% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}
 {% endif %}
 {% if visible_children %}
-Overview
---------
+
 
 {% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}
 {% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}
 {% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %}
 {% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}
+Overview
+--------
 {% block classes scoped %}
 {% if visible_classes %}
 {{ macros.auto_summary(visible_classes, title="Classes") }}

diff --git a/docs/source/config_options.rst b/docs/source/config_options.rst
@@ -0,0 +1,6 @@
+.. _configopts:
+
+Configuration Options
+#####################
+
+.. include:: ./autoapi/numba_dpex/core/config/index.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -48,6 +48,7 @@ Data Parallel Extension for Numba*
    programming_model
    user_guide/index
    autoapi/index
+   config_options
    experimental/index
    useful_links
 

diff --git a/docs/source/user_guide/config.rst b/docs/source/user_guide/config.rst