Skip to content

Commit

Permalink
docs: add configuration for automatic filters docs generation (#173)
Browse files Browse the repository at this point in the history
  • Loading branch information
mariajgrimaldi committed Jun 21, 2024
1 parent 7e5c196 commit 8505116
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 4 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Change Log
Unreleased
----------
* Configuration for automatic filters docs generation.

[1.9.0] - 2024-06-14
--------------------
Expand Down
9 changes: 5 additions & 4 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 -----------------------------------------------------

Expand All @@ -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.
Expand Down
10 changes: 10 additions & 0 deletions docs/reference/filters.rst
Original file line number Diff line number Diff line change
@@ -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:
1 change: 1 addition & 0 deletions docs/reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ References
:maxdepth: 1
:caption: Contents:

filters
django-plugins-and-filters

0 comments on commit 8505116

Please sign in to comment.