docs: add configuration for automatic filters docs generation

openedx · Jun 4, 2024 · 734207c · 734207c
1 parent 16de16c
commit 734207c
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 0 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -35,6 +35,8 @@
     'sphinx_copybutton',
     'sphinx.ext.graphviz',
     'sphinxcontrib.mermaid',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/reference/filters.rst b/docs/reference/filters.rst
@@ -0,0 +1,10 @@
+Filters
+=======
+
+This is the list of Open edX Filters found in this repository.
+
+.. note::
+    Filters can be created in other projects and plugins as well, but these default filters are guaranteed to exist.
+
+.. automodule:: openedx_filters.learning.filters
+   :members:
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -6,3 +6,4 @@ References
    :caption: Contents:
 
    django-plugins-and-filters
+   filters
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,3 +6,4 @@ References
		:caption: Contents:

		django-plugins-and-filters
		filters