From 8676e9cbdf422226f354065d67cae95d4d84d839 Mon Sep 17 00:00:00 2001 From: Maria Grimaldi Date: Tue, 4 Jun 2024 15:19:55 -0400 Subject: [PATCH] docs: add configuration for automatic filters docs generation --- docs/conf.py | 9 +++++---- docs/reference/filters.rst | 10 ++++++++++ docs/reference/index.rst | 1 + 3 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 docs/reference/filters.rst diff --git a/docs/conf.py b/docs/conf.py index 1b553424..e9d45068 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,10 +10,9 @@ # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # -# import os -# import sys -# sys.path.insert(0, os.path.abspath('.')) - +import os +import sys +sys.path.insert(0, os.path.abspath('..')) # -- Project information ----------------------------------------------------- @@ -35,6 +34,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 new file mode 100644 index 00000000..218dc46b --- /dev/null +++ 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 index 06f61ee5..f7697f2c 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -6,3 +6,4 @@ References :caption: Contents: django-plugins-and-filters + filters