From fca09653a1c9b88869d58500e716a59e135e7afd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Seppo=20=C3=84yr=C3=A4v=C3=A4inen?= Date: Mon, 10 Mar 2025 10:20:05 +0200 Subject: [PATCH] Add code docs generation and deployment to GitHub Pages for A-plus. --- .github/workflows/deploy-docs.yml | 44 ++ authorization/api/views.py | 10 +- docs/Makefile | 20 + docs/make.bat | 35 ++ docs/source/api.rst | 21 + docs/source/aplus.api.rst | 10 + docs/source/aplus.en.rst | 21 + docs/source/aplus.fi.rst | 21 + docs/source/aplus.rst | 71 +++ docs/source/apps.migrations.rst | 45 ++ docs/source/apps.rst | 70 +++ docs/source/apps.templatetags.rst | 21 + docs/source/authorization.api.rst | 29 + docs/source/authorization.migrations.rst | 10 + docs/source/authorization.rst | 62 +++ docs/source/conf.py | 45 ++ docs/source/course.api.rst | 69 +++ docs/source/course.cache.rst | 29 + docs/source/course.migrations.rst | 517 ++++++++++++++++++ docs/source/course.rst | 152 +++++ docs/source/course.templatetags.rst | 29 + docs/source/deviations.migrations.rst | 61 +++ docs/source/deviations.rst | 78 +++ docs/source/deviations.templatetags.rst | 21 + docs/source/diploma.migrations.rst | 45 ++ docs/source/diploma.rst | 78 +++ docs/source/diploma.templatetags.rst | 21 + docs/source/e2e_tests.rst | 53 ++ .../edit_course.management.commands.rst | 21 + docs/source/edit_course.management.rst | 18 + docs/source/edit_course.migrations.rst | 10 + docs/source/edit_course.operations.rst | 45 ++ docs/source/edit_course.rst | 80 +++ docs/source/edit_course.templatetags.rst | 21 + docs/source/exercise.api.csv.rst | 53 ++ docs/source/exercise.api.rst | 69 +++ docs/source/exercise.cache.rst | 69 +++ docs/source/exercise.management.commands.rst | 45 ++ docs/source/exercise.management.rst | 18 + docs/source/exercise.migrations.rst | 421 ++++++++++++++ docs/source/exercise.protocol.rst | 29 + docs/source/exercise.rst | 170 ++++++ docs/source/exercise.templatetags.rst | 21 + docs/source/external_services.api.rst | 69 +++ .../external_services.management.commands.rst | 21 + docs/source/external_services.management.rst | 18 + docs/source/external_services.migrations.rst | 165 ++++++ docs/source/external_services.rst | 104 ++++ .../source/external_services.templatetags.rst | 21 + docs/source/index.rst | 23 + docs/source/inheritance.migrations.rst | 21 + docs/source/inheritance.rst | 29 + docs/source/lib.api.authentication.rst | 21 + docs/source/lib.api.rst | 85 +++ docs/source/lib.cache.rst | 53 ++ docs/source/lib.crypto.rst | 29 + docs/source/lib.rst | 183 +++++++ docs/source/lti_tool.rst | 37 ++ docs/source/manage.rst | 7 + docs/source/modules.rst | 28 + docs/source/news.migrations.rst | 53 ++ docs/source/news.rst | 70 +++ docs/source/news.templatetags.rst | 21 + docs/source/notification.migrations.rst | 61 +++ docs/source/notification.rst | 70 +++ docs/source/notification.templatetags.rst | 21 + docs/source/redirect_old_urls.rst | 37 ++ docs/source/shibboleth_login.rst | 61 +++ docs/source/site_alert.migrations.rst | 21 + docs/source/site_alert.rst | 45 ++ docs/source/threshold.migrations.rst | 37 ++ docs/source/threshold.rst | 53 ++ docs/source/userprofile.api.rst | 45 ++ .../userprofile.management.commands.rst | 37 ++ docs/source/userprofile.management.rst | 18 + docs/source/userprofile.migrations.rst | 61 +++ docs/source/userprofile.rst | 95 ++++ edit_course/operations/tests.py | 9 +- 78 files changed, 4498 insertions(+), 9 deletions(-) create mode 100644 .github/workflows/deploy-docs.yml create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/api.rst create mode 100644 docs/source/aplus.api.rst create mode 100644 docs/source/aplus.en.rst create mode 100644 docs/source/aplus.fi.rst create mode 100644 docs/source/aplus.rst create mode 100644 docs/source/apps.migrations.rst create mode 100644 docs/source/apps.rst create mode 100644 docs/source/apps.templatetags.rst create mode 100644 docs/source/authorization.api.rst create mode 100644 docs/source/authorization.migrations.rst create mode 100644 docs/source/authorization.rst create mode 100644 docs/source/conf.py create mode 100644 docs/source/course.api.rst create mode 100644 docs/source/course.cache.rst create mode 100644 docs/source/course.migrations.rst create mode 100644 docs/source/course.rst create mode 100644 docs/source/course.templatetags.rst create mode 100644 docs/source/deviations.migrations.rst create mode 100644 docs/source/deviations.rst create mode 100644 docs/source/deviations.templatetags.rst create mode 100644 docs/source/diploma.migrations.rst create mode 100644 docs/source/diploma.rst create mode 100644 docs/source/diploma.templatetags.rst create mode 100644 docs/source/e2e_tests.rst create mode 100644 docs/source/edit_course.management.commands.rst create mode 100644 docs/source/edit_course.management.rst create mode 100644 docs/source/edit_course.migrations.rst create mode 100644 docs/source/edit_course.operations.rst create mode 100644 docs/source/edit_course.rst create mode 100644 docs/source/edit_course.templatetags.rst create mode 100644 docs/source/exercise.api.csv.rst create mode 100644 docs/source/exercise.api.rst create mode 100644 docs/source/exercise.cache.rst create mode 100644 docs/source/exercise.management.commands.rst create mode 100644 docs/source/exercise.management.rst create mode 100644 docs/source/exercise.migrations.rst create mode 100644 docs/source/exercise.protocol.rst create mode 100644 docs/source/exercise.rst create mode 100644 docs/source/exercise.templatetags.rst create mode 100644 docs/source/external_services.api.rst create mode 100644 docs/source/external_services.management.commands.rst create mode 100644 docs/source/external_services.management.rst create mode 100644 docs/source/external_services.migrations.rst create mode 100644 docs/source/external_services.rst create mode 100644 docs/source/external_services.templatetags.rst create mode 100644 docs/source/index.rst create mode 100644 docs/source/inheritance.migrations.rst create mode 100644 docs/source/inheritance.rst create mode 100644 docs/source/lib.api.authentication.rst create mode 100644 docs/source/lib.api.rst create mode 100644 docs/source/lib.cache.rst create mode 100644 docs/source/lib.crypto.rst create mode 100644 docs/source/lib.rst create mode 100644 docs/source/lti_tool.rst create mode 100644 docs/source/manage.rst create mode 100644 docs/source/modules.rst create mode 100644 docs/source/news.migrations.rst create mode 100644 docs/source/news.rst create mode 100644 docs/source/news.templatetags.rst create mode 100644 docs/source/notification.migrations.rst create mode 100644 docs/source/notification.rst create mode 100644 docs/source/notification.templatetags.rst create mode 100644 docs/source/redirect_old_urls.rst create mode 100644 docs/source/shibboleth_login.rst create mode 100644 docs/source/site_alert.migrations.rst create mode 100644 docs/source/site_alert.rst create mode 100644 docs/source/threshold.migrations.rst create mode 100644 docs/source/threshold.rst create mode 100644 docs/source/userprofile.api.rst create mode 100644 docs/source/userprofile.management.commands.rst create mode 100644 docs/source/userprofile.management.rst create mode 100644 docs/source/userprofile.migrations.rst create mode 100644 docs/source/userprofile.rst diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml new file mode 100644 index 000000000..f66c28bec --- /dev/null +++ b/.github/workflows/deploy-docs.yml @@ -0,0 +1,44 @@ +name: Deploy A+ Documentation + +on: + push: + branches: + - master # or the branch you want to trigger the deployment + +jobs: + build-and-deploy: + runs-on: ubuntu-22.04 + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Set up Python + uses: actions/setup-python@v2 + with: + python-version: '3.10' # specify your Python version + + - name: Install dependencies + run: | + sudo apt-get install libxml2-dev libxslt-dev + python -m pip install --upgrade pip setuptools wheel + pip install -r requirements.txt + pip install -r requirements_testing.txt + pip install sphinx sphinx-rtd-theme + + - name: Set environment variables + run: echo "BASE_URL=http://localhost:8000/" >> $GITHUB_ENV + + - name: Build documentation + env: + APLUS_BASE_URL: ${{ env.BASE_URL }} + run: | + sphinx-build -b html docs/source docs/build/_build/html + + - name: Deploy to GitHub Pages + uses: peaceiris/actions-gh-pages@v4 + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/build/_build/html + force_orphan: true \ No newline at end of file diff --git a/authorization/api/views.py b/authorization/api/views.py index d513a8fd8..537b395b5 100644 --- a/authorization/api/views.py +++ b/authorization/api/views.py @@ -20,13 +20,13 @@ class RemoteAuthenticationView(RemoteAuthenticator, APIView): Relevant payload fields: - exp: expiration time. If present, either a NumericDate integer, or a string - in ISO calendar format (expire at) or HH:MM:SS format (expire in) + in ISO calendar format (expire at) or HH:MM:SS format (expire in) - turl/taud: taud is the public key of the target service (with whom this token - is supposed to be used), alternatively, one can give turl which is the target's - alias or URL known by A+. + is supposed to be used), alternatively, one can give turl which is the target's + alias or URL known by A+. - permissions: list of permissions to be included. - See [AUTH.md](https://github.com/apluslms/a-plus/blob/master/doc/AUTH.md#permission-claims). - For example, [["instance", 1, {"id": 5}]] where "5" is the id of the course instance. + See [AUTH.md](https://github.com/apluslms/a-plus/blob/master/doc/AUTH.md#permission-claims). + For example, [["instance", 1, {"id": 5}]] where "5" is the id of the course instance. GET assumes the payload is sent as a part of a JWT token. diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 000000000..d0c3cbf10 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 000000000..747ffb7b3 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/api.rst b/docs/source/api.rst new file mode 100644 index 000000000..e85d74680 --- /dev/null +++ b/docs/source/api.rst @@ -0,0 +1,21 @@ +api package +=========== + +Submodules +---------- + +api.urls\_v2 module +------------------- + +.. automodule:: api.urls_v2 + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/aplus.api.rst b/docs/source/aplus.api.rst new file mode 100644 index 000000000..7ca185bf8 --- /dev/null +++ b/docs/source/aplus.api.rst @@ -0,0 +1,10 @@ +aplus.api package +================= + +Module contents +--------------- + +.. automodule:: aplus.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/aplus.en.rst b/docs/source/aplus.en.rst new file mode 100644 index 000000000..9cb871efb --- /dev/null +++ b/docs/source/aplus.en.rst @@ -0,0 +1,21 @@ +aplus.en package +================ + +Submodules +---------- + +aplus.en.formats module +----------------------- + +.. automodule:: aplus.en.formats + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: aplus.en + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/aplus.fi.rst b/docs/source/aplus.fi.rst new file mode 100644 index 000000000..99d44fd99 --- /dev/null +++ b/docs/source/aplus.fi.rst @@ -0,0 +1,21 @@ +aplus.fi package +================ + +Submodules +---------- + +aplus.fi.formats module +----------------------- + +.. automodule:: aplus.fi.formats + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: aplus.fi + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/aplus.rst b/docs/source/aplus.rst new file mode 100644 index 000000000..d5db8b10c --- /dev/null +++ b/docs/source/aplus.rst @@ -0,0 +1,71 @@ +aplus package +============= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + aplus.api + aplus.en + aplus.fi + +Submodules +---------- + +aplus.celery module +------------------- + +.. automodule:: aplus.celery + :members: + :undoc-members: + :show-inheritance: + +aplus.local\_settings module +---------------------------- + +.. automodule:: aplus.local_settings + :members: + :undoc-members: + :show-inheritance: + +aplus.settings module +--------------------- + +.. automodule:: aplus.settings + :members: + :undoc-members: + :show-inheritance: + +aplus.urls module +----------------- + +.. automodule:: aplus.urls + :members: + :undoc-members: + :show-inheritance: + +aplus.views module +------------------ + +.. automodule:: aplus.views + :members: + :undoc-members: + :show-inheritance: + +aplus.wsgi module +----------------- + +.. automodule:: aplus.wsgi + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: aplus + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/apps.migrations.rst b/docs/source/apps.migrations.rst new file mode 100644 index 000000000..cd17769ec --- /dev/null +++ b/docs/source/apps.migrations.rst @@ -0,0 +1,45 @@ +apps.migrations package +======================= + +Submodules +---------- + +apps.migrations.0001\_initial module +------------------------------------ + +.. automodule:: apps.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +apps.migrations.0002\_auto\_20150527\_1004 module +------------------------------------------------- + +.. automodule:: apps.migrations.0002_auto_20150527_1004 + :members: + :undoc-members: + :show-inheritance: + +apps.migrations.0003\_auto\_20210701\_1730 module +------------------------------------------------- + +.. automodule:: apps.migrations.0003_auto_20210701_1730 + :members: + :undoc-members: + :show-inheritance: + +apps.migrations.0004\_auto\_20210812\_1536 module +------------------------------------------------- + +.. automodule:: apps.migrations.0004_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: apps.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/apps.rst b/docs/source/apps.rst new file mode 100644 index 000000000..9de424b7d --- /dev/null +++ b/docs/source/apps.rst @@ -0,0 +1,70 @@ +apps package +============ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + apps.migrations + apps.templatetags + +Submodules +---------- + +apps.admin module +----------------- + +.. automodule:: apps.admin + :members: + :undoc-members: + :show-inheritance: + +apps.app\_renderers module +-------------------------- + +.. automodule:: apps.app_renderers + :members: + :undoc-members: + :show-inheritance: + +apps.models module +------------------ + +.. automodule:: apps.models + :members: + :undoc-members: + :show-inheritance: + +apps.tests module +----------------- + +.. automodule:: apps.tests + :members: + :undoc-members: + :show-inheritance: + +apps.urls module +---------------- + +.. automodule:: apps.urls + :members: + :undoc-members: + :show-inheritance: + +apps.views module +----------------- + +.. automodule:: apps.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: apps + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/apps.templatetags.rst b/docs/source/apps.templatetags.rst new file mode 100644 index 000000000..0695f91fb --- /dev/null +++ b/docs/source/apps.templatetags.rst @@ -0,0 +1,21 @@ +apps.templatetags package +========================= + +Submodules +---------- + +apps.templatetags.apps module +----------------------------- + +.. automodule:: apps.templatetags.apps + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: apps.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/authorization.api.rst b/docs/source/authorization.api.rst new file mode 100644 index 000000000..82f99e61a --- /dev/null +++ b/docs/source/authorization.api.rst @@ -0,0 +1,29 @@ +authorization.api package +========================= + +Submodules +---------- + +authorization.api.mixins module +------------------------------- + +.. automodule:: authorization.api.mixins + :members: + :undoc-members: + :show-inheritance: + +authorization.api.views module +------------------------------ + +.. automodule:: authorization.api.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: authorization.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/authorization.migrations.rst b/docs/source/authorization.migrations.rst new file mode 100644 index 000000000..e8348e10e --- /dev/null +++ b/docs/source/authorization.migrations.rst @@ -0,0 +1,10 @@ +authorization.migrations package +================================ + +Module contents +--------------- + +.. automodule:: authorization.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/authorization.rst b/docs/source/authorization.rst new file mode 100644 index 000000000..50409b404 --- /dev/null +++ b/docs/source/authorization.rst @@ -0,0 +1,62 @@ +authorization package +===================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + authorization.api + authorization.migrations + +Submodules +---------- + +authorization.exceptions module +------------------------------- + +.. automodule:: authorization.exceptions + :members: + :undoc-members: + :show-inheritance: + +authorization.models module +--------------------------- + +.. automodule:: authorization.models + :members: + :undoc-members: + :show-inheritance: + +authorization.object\_permissions module +---------------------------------------- + +.. automodule:: authorization.object_permissions + :members: + :undoc-members: + :show-inheritance: + +authorization.permissions module +-------------------------------- + +.. automodule:: authorization.permissions + :members: + :undoc-members: + :show-inheritance: + +authorization.views module +-------------------------- + +.. automodule:: authorization.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: authorization + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 000000000..6a0b73cc8 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,45 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +import os +import sys +import django + +sys.path.insert(0, os.path.abspath('../..')) + +# Set the BASE_URL environment variable if not already set +os.environ.setdefault("BASE_URL", "http://localhost:8000/") +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "aplus.settings") +django.setup() + +project = 'A+' +copyright = '2025, A+ development team' +author = 'A+ development team' +release = '1.28' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.githubpages', +] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] diff --git a/docs/source/course.api.rst b/docs/source/course.api.rst new file mode 100644 index 000000000..1985ba4b4 --- /dev/null +++ b/docs/source/course.api.rst @@ -0,0 +1,69 @@ +course.api package +================== + +Submodules +---------- + +course.api.full\_serializers module +----------------------------------- + +.. automodule:: course.api.full_serializers + :members: + :undoc-members: + :show-inheritance: + +course.api.lti\_serializers module +---------------------------------- + +.. automodule:: course.api.lti_serializers + :members: + :undoc-members: + :show-inheritance: + +course.api.lti\_views module +---------------------------- + +.. automodule:: course.api.lti_views + :members: + :undoc-members: + :show-inheritance: + +course.api.mixins module +------------------------ + +.. automodule:: course.api.mixins + :members: + :undoc-members: + :show-inheritance: + +course.api.serializers module +----------------------------- + +.. automodule:: course.api.serializers + :members: + :undoc-members: + :show-inheritance: + +course.api.tests module +----------------------- + +.. automodule:: course.api.tests + :members: + :undoc-members: + :show-inheritance: + +course.api.views module +----------------------- + +.. automodule:: course.api.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: course.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/course.cache.rst b/docs/source/course.cache.rst new file mode 100644 index 000000000..d7015277c --- /dev/null +++ b/docs/source/course.cache.rst @@ -0,0 +1,29 @@ +course.cache package +==================== + +Submodules +---------- + +course.cache.menu module +------------------------ + +.. automodule:: course.cache.menu + :members: + :undoc-members: + :show-inheritance: + +course.cache.students module +---------------------------- + +.. automodule:: course.cache.students + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: course.cache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/course.migrations.rst b/docs/source/course.migrations.rst new file mode 100644 index 000000000..beed06e69 --- /dev/null +++ b/docs/source/course.migrations.rst @@ -0,0 +1,517 @@ +course.migrations package +========================= + +Submodules +---------- + +course.migrations.0001\_initial module +-------------------------------------- + +.. automodule:: course.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0002\_auto\_20150427\_1717 module +--------------------------------------------------- + +.. automodule:: course.migrations.0002_auto_20150427_1717 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0003\_auto\_20150617\_0654 module +--------------------------------------------------- + +.. automodule:: course.migrations.0003_auto_20150617_0654 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0004\_auto\_20150625\_1821 module +--------------------------------------------------- + +.. automodule:: course.migrations.0004_auto_20150625_1821 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0005\_auto\_20150625\_1835 module +--------------------------------------------------- + +.. automodule:: course.migrations.0005_auto_20150625_1835 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0006\_auto\_20150721\_1152 module +--------------------------------------------------- + +.. automodule:: course.migrations.0006_auto_20150721_1152 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0007\_auto\_20150828\_1210 module +--------------------------------------------------- + +.. automodule:: course.migrations.0007_auto_20150828_1210 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0008\_courseinstance\_technical\_error\_emails module +----------------------------------------------------------------------- + +.. automodule:: course.migrations.0008_courseinstance_technical_error_emails + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0009\_auto\_20151013\_1434 module +--------------------------------------------------- + +.. automodule:: course.migrations.0009_auto_20151013_1434 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0010\_auto\_20151214\_1714 module +--------------------------------------------------- + +.. automodule:: course.migrations.0010_auto_20151214_1714 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0011\_auto\_20151215\_1133 module +--------------------------------------------------- + +.. automodule:: course.migrations.0011_auto_20151215_1133 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0012\_auto\_20151218\_0857 module +--------------------------------------------------- + +.. automodule:: course.migrations.0012_auto_20151218_0857 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0013\_auto\_20151223\_1937 module +--------------------------------------------------- + +.. automodule:: course.migrations.0013_auto_20151223_1937 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0014\_auto\_20160106\_1303 module +--------------------------------------------------- + +.. automodule:: course.migrations.0014_auto_20160106_1303 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0015\_auto\_20160121\_1544 module +--------------------------------------------------- + +.. automodule:: course.migrations.0015_auto_20160121_1544 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0016\_auto\_20160124\_2214 module +--------------------------------------------------- + +.. automodule:: course.migrations.0016_auto_20160124_2214 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0017\_enroll\_submitters module +------------------------------------------------- + +.. automodule:: course.migrations.0017_enroll_submitters + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0018\_auto\_20160205\_1240 module +--------------------------------------------------- + +.. automodule:: course.migrations.0018_auto_20160205_1240 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0019\_auto\_20160205\_1312 module +--------------------------------------------------- + +.. automodule:: course.migrations.0019_auto_20160205_1312 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0020\_auto\_20160615\_1239 module +--------------------------------------------------- + +.. automodule:: course.migrations.0020_auto_20160615_1239 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0021\_auto\_20160726\_1209 module +--------------------------------------------------- + +.. automodule:: course.migrations.0021_auto_20160726_1209 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0022\_copy\_enrollments module +------------------------------------------------ + +.. automodule:: course.migrations.0022_copy_enrollments + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0023\_delete\_students module +----------------------------------------------- + +.. automodule:: course.migrations.0023_delete_students + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0024\_auto\_20160726\_1232 module +--------------------------------------------------- + +.. automodule:: course.migrations.0024_auto_20160726_1232 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0025\_auto\_20160728\_1139 module +--------------------------------------------------- + +.. automodule:: course.migrations.0025_auto_20160728_1139 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0026\_auto\_20160809\_1551 module +--------------------------------------------------- + +.. automodule:: course.migrations.0026_auto_20160809_1551 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0027\_courseinstance\_head\_urls module +--------------------------------------------------------- + +.. automodule:: course.migrations.0027_courseinstance_head_urls + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0028\_auto\_20160825\_0601 module +--------------------------------------------------- + +.. automodule:: course.migrations.0028_auto_20160825_0601 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0029\_usertags module +--------------------------------------- + +.. automodule:: course.migrations.0029_usertags + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0030\_auto\_20160912\_1341 module +--------------------------------------------------- + +.. automodule:: course.migrations.0030_auto_20160912_1341 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0031\_courseinstance\_build\_log\_url module +-------------------------------------------------------------- + +.. automodule:: course.migrations.0031_courseinstance_build_log_url + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0032\_auto\_20170215\_0953 module +--------------------------------------------------- + +.. automodule:: course.migrations.0032_auto_20170215_0953 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0033\_auto\_20170428\_1213 module +--------------------------------------------------- + +.. automodule:: course.migrations.0033_auto_20170428_1213 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0034\_auto\_20170609\_1600 module +--------------------------------------------------- + +.. automodule:: course.migrations.0034_auto_20170609_1600 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0035\_courseinstance\_last\_modified module +------------------------------------------------------------- + +.. automodule:: course.migrations.0035_courseinstance_last_modified + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0036\_auto\_20170907\_1537 module +--------------------------------------------------- + +.. automodule:: course.migrations.0036_auto_20170907_1537 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0037\_auto\_20180108\_1850 module +--------------------------------------------------- + +.. automodule:: course.migrations.0037_auto_20180108_1850 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0038\_auto\_20180212\_1556 module +--------------------------------------------------- + +.. automodule:: course.migrations.0038_auto_20180212_1556 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0039\_auto\_20180326\_1425 module +--------------------------------------------------- + +.. automodule:: course.migrations.0039_auto_20180326_1425 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0040\_auto\_20180607\_1502 module +--------------------------------------------------- + +.. automodule:: course.migrations.0040_auto_20180607_1502 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0041\_auto\_20180920\_1838 module +--------------------------------------------------- + +.. automodule:: course.migrations.0041_auto_20180920_1838 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0042\_auto\_20190327\_1355 module +--------------------------------------------------- + +.. automodule:: course.migrations.0042_auto_20190327_1355 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0043\_auto\_20190412\_1706 module +--------------------------------------------------- + +.. automodule:: course.migrations.0043_auto_20190412_1706 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0044\_auto\_20190415\_1807 module +--------------------------------------------------- + +.. automodule:: course.migrations.0044_auto_20190415_1807 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0045\_hardcodedusertag module +----------------------------------------------- + +.. automodule:: course.migrations.0045_hardcodedusertag + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0046\_coursemodule\_reading\_opening\_time module +------------------------------------------------------------------- + +.. automodule:: course.migrations.0046_coursemodule_reading_opening_time + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0047\_enrollment\_language module +--------------------------------------------------- + +.. automodule:: course.migrations.0047_enrollment_language + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0048\_delete\_duplicate\_enrollments module +------------------------------------------------------------- + +.. automodule:: course.migrations.0048_delete_duplicate_enrollments + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0049\_auto\_20210701\_1730 module +--------------------------------------------------- + +.. automodule:: course.migrations.0049_auto_20210701_1730 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0050\_enrollment\_roles module +------------------------------------------------ + +.. automodule:: course.migrations.0050_enrollment_roles + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0051\_auto\_20210812\_1536 module +--------------------------------------------------- + +.. automodule:: course.migrations.0051_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0052\_courseinstance\_sis\_id module +------------------------------------------------------ + +.. automodule:: course.migrations.0052_courseinstance_sis_id + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0053\_enrollment\_from\_sis module +---------------------------------------------------- + +.. automodule:: course.migrations.0053_enrollment_from_sis + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0054\_courseinstance\_sis\_enroll module +---------------------------------------------------------- + +.. automodule:: course.migrations.0054_courseinstance_sis_enroll + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0055\_alter\_enrollment\_status module +-------------------------------------------------------- + +.. automodule:: course.migrations.0055_alter_enrollment_status + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0056\_enrollment\_time\_help\_text module +----------------------------------------------------------- + +.. automodule:: course.migrations.0056_enrollment_time_help_text + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0057\_usertagging\_rename\_index module +--------------------------------------------------------- + +.. automodule:: course.migrations.0057_usertagging_rename_index + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0058\_coursemodule\_model\_answer\_and\_more module +--------------------------------------------------------------------- + +.. automodule:: course.migrations.0058_coursemodule_model_answer_and_more + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0059\_submissiontag module +-------------------------------------------- + +.. automodule:: course.migrations.0059_submissiontag + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0060\_studentmodulegoal module +------------------------------------------------ + +.. automodule:: course.migrations.0060_studentmodulegoal + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0061\_courseinstance\_points\_goal\_enabled module +-------------------------------------------------------------------- + +.. automodule:: course.migrations.0061_courseinstance_points_goal_enabled + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0062\_studentmodulegoal\_unique\_student\_module\_goal module +------------------------------------------------------------------------------- + +.. automodule:: course.migrations.0062_studentmodulegoal_unique_student_module_goal + :members: + :undoc-members: + :show-inheritance: + +course.migrations.0063\_courseinstance\_group\_work\_allowed module +------------------------------------------------------------------- + +.. automodule:: course.migrations.0063_courseinstance_group_work_allowed + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: course.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/course.rst b/docs/source/course.rst new file mode 100644 index 000000000..05812464b --- /dev/null +++ b/docs/source/course.rst @@ -0,0 +1,152 @@ +course package +============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + course.api + course.cache + course.migrations + course.templatetags + +Submodules +---------- + +course.admin module +------------------- + +.. automodule:: course.admin + :members: + :undoc-members: + :show-inheritance: + +course.exceptions module +------------------------ + +.. automodule:: course.exceptions + :members: + :undoc-members: + :show-inheritance: + +course.forms module +------------------- + +.. automodule:: course.forms + :members: + :undoc-members: + :show-inheritance: + +course.long\_urls module +------------------------ + +.. automodule:: course.long_urls + :members: + :undoc-members: + :show-inheritance: + +course.models module +-------------------- + +.. automodule:: course.models + :members: + :undoc-members: + :show-inheritance: + +course.permissions module +------------------------- + +.. automodule:: course.permissions + :members: + :undoc-members: + :show-inheritance: + +course.renders module +--------------------- + +.. automodule:: course.renders + :members: + :undoc-members: + :show-inheritance: + +course.sis module +----------------- + +.. automodule:: course.sis + :members: + :undoc-members: + :show-inheritance: + +course.sis\_test module +----------------------- + +.. automodule:: course.sis_test + :members: + :undoc-members: + :show-inheritance: + +course.sitemaps module +---------------------- + +.. automodule:: course.sitemaps + :members: + :undoc-members: + :show-inheritance: + +course.staff\_views module +-------------------------- + +.. automodule:: course.staff_views + :members: + :undoc-members: + :show-inheritance: + +course.test\_visibility\_enroll module +-------------------------------------- + +.. automodule:: course.test_visibility_enroll + :members: + :undoc-members: + :show-inheritance: + +course.tests module +------------------- + +.. automodule:: course.tests + :members: + :undoc-members: + :show-inheritance: + +course.urls module +------------------ + +.. automodule:: course.urls + :members: + :undoc-members: + :show-inheritance: + +course.viewbase module +---------------------- + +.. automodule:: course.viewbase + :members: + :undoc-members: + :show-inheritance: + +course.views module +------------------- + +.. automodule:: course.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: course + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/course.templatetags.rst b/docs/source/course.templatetags.rst new file mode 100644 index 000000000..60c145c30 --- /dev/null +++ b/docs/source/course.templatetags.rst @@ -0,0 +1,29 @@ +course.templatetags package +=========================== + +Submodules +---------- + +course.templatetags.base module +------------------------------- + +.. automodule:: course.templatetags.base + :members: + :undoc-members: + :show-inheritance: + +course.templatetags.course module +--------------------------------- + +.. automodule:: course.templatetags.course + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: course.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/deviations.migrations.rst b/docs/source/deviations.migrations.rst new file mode 100644 index 000000000..96fb74b92 --- /dev/null +++ b/docs/source/deviations.migrations.rst @@ -0,0 +1,61 @@ +deviations.migrations package +============================= + +Submodules +---------- + +deviations.migrations.0001\_initial module +------------------------------------------ + +.. automodule:: deviations.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +deviations.migrations.0002\_deadlineruledeviation\_without\_late\_penalty module +-------------------------------------------------------------------------------- + +.. automodule:: deviations.migrations.0002_deadlineruledeviation_without_late_penalty + :members: + :undoc-members: + :show-inheritance: + +deviations.migrations.0003\_auto\_20210812\_1536 module +------------------------------------------------------- + +.. automodule:: deviations.migrations.0003_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +deviations.migrations.0004\_auto\_20211207\_1459 module +------------------------------------------------------- + +.. automodule:: deviations.migrations.0004_auto_20211207_1459 + :members: + :undoc-members: + :show-inheritance: + +deviations.migrations.0005\_auto\_20220211\_1540 module +------------------------------------------------------- + +.. automodule:: deviations.migrations.0005_auto_20220211_1540 + :members: + :undoc-members: + :show-inheritance: + +deviations.migrations.0006\_rename\_extra\_minutes\_deadlineruledeviation\_extra\_seconds module +------------------------------------------------------------------------------------------------ + +.. automodule:: deviations.migrations.0006_rename_extra_minutes_deadlineruledeviation_extra_seconds + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: deviations.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/deviations.rst b/docs/source/deviations.rst new file mode 100644 index 000000000..dbf4c8163 --- /dev/null +++ b/docs/source/deviations.rst @@ -0,0 +1,78 @@ +deviations package +================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + deviations.migrations + deviations.templatetags + +Submodules +---------- + +deviations.admin module +----------------------- + +.. automodule:: deviations.admin + :members: + :undoc-members: + :show-inheritance: + +deviations.forms module +----------------------- + +.. automodule:: deviations.forms + :members: + :undoc-members: + :show-inheritance: + +deviations.models module +------------------------ + +.. automodule:: deviations.models + :members: + :undoc-members: + :show-inheritance: + +deviations.tests module +----------------------- + +.. automodule:: deviations.tests + :members: + :undoc-members: + :show-inheritance: + +deviations.urls module +---------------------- + +.. automodule:: deviations.urls + :members: + :undoc-members: + :show-inheritance: + +deviations.viewbase module +-------------------------- + +.. automodule:: deviations.viewbase + :members: + :undoc-members: + :show-inheritance: + +deviations.views module +----------------------- + +.. automodule:: deviations.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: deviations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/deviations.templatetags.rst b/docs/source/deviations.templatetags.rst new file mode 100644 index 000000000..7370838b3 --- /dev/null +++ b/docs/source/deviations.templatetags.rst @@ -0,0 +1,21 @@ +deviations.templatetags package +=============================== + +Submodules +---------- + +deviations.templatetags.deviations module +----------------------------------------- + +.. automodule:: deviations.templatetags.deviations + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: deviations.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/diploma.migrations.rst b/docs/source/diploma.migrations.rst new file mode 100644 index 000000000..329c97c82 --- /dev/null +++ b/docs/source/diploma.migrations.rst @@ -0,0 +1,45 @@ +diploma.migrations package +========================== + +Submodules +---------- + +diploma.migrations.0001\_initial module +--------------------------------------- + +.. automodule:: diploma.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +diploma.migrations.0002\_coursediplomadesign\_availability module +----------------------------------------------------------------- + +.. automodule:: diploma.migrations.0002_coursediplomadesign_availability + :members: + :undoc-members: + :show-inheritance: + +diploma.migrations.0003\_alter\_coursediplomadesign\_availability module +------------------------------------------------------------------------ + +.. automodule:: diploma.migrations.0003_alter_coursediplomadesign_availability + :members: + :undoc-members: + :show-inheritance: + +diploma.migrations.0004\_auto\_20210812\_1536 module +---------------------------------------------------- + +.. automodule:: diploma.migrations.0004_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: diploma.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/diploma.rst b/docs/source/diploma.rst new file mode 100644 index 000000000..0395a6807 --- /dev/null +++ b/docs/source/diploma.rst @@ -0,0 +1,78 @@ +diploma package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + diploma.migrations + diploma.templatetags + +Submodules +---------- + +diploma.admin module +-------------------- + +.. automodule:: diploma.admin + :members: + :undoc-members: + :show-inheritance: + +diploma.grade module +-------------------- + +.. automodule:: diploma.grade + :members: + :undoc-members: + :show-inheritance: + +diploma.models module +--------------------- + +.. automodule:: diploma.models + :members: + :undoc-members: + :show-inheritance: + +diploma.pdf module +------------------ + +.. automodule:: diploma.pdf + :members: + :undoc-members: + :show-inheritance: + +diploma.tests module +-------------------- + +.. automodule:: diploma.tests + :members: + :undoc-members: + :show-inheritance: + +diploma.urls module +------------------- + +.. automodule:: diploma.urls + :members: + :undoc-members: + :show-inheritance: + +diploma.views module +-------------------- + +.. automodule:: diploma.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: diploma + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/diploma.templatetags.rst b/docs/source/diploma.templatetags.rst new file mode 100644 index 000000000..a8f0d8568 --- /dev/null +++ b/docs/source/diploma.templatetags.rst @@ -0,0 +1,21 @@ +diploma.templatetags package +============================ + +Submodules +---------- + +diploma.templatetags.diploma module +----------------------------------- + +.. automodule:: diploma.templatetags.diploma + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: diploma.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/e2e_tests.rst b/docs/source/e2e_tests.rst new file mode 100644 index 000000000..34bde1d4a --- /dev/null +++ b/docs/source/e2e_tests.rst @@ -0,0 +1,53 @@ +e2e\_tests package +================== + +Submodules +---------- + +e2e\_tests.conftest module +-------------------------- + +.. automodule:: e2e_tests.conftest + :members: + :undoc-members: + :show-inheritance: + +e2e\_tests.helpers module +------------------------- + +.. automodule:: e2e_tests.helpers + :members: + :undoc-members: + :show-inheritance: + +e2e\_tests.test\_compare\_submissions module +-------------------------------------------- + +.. automodule:: e2e_tests.test_compare_submissions + :members: + :undoc-members: + :show-inheritance: + +e2e\_tests.test\_example module +------------------------------- + +.. automodule:: e2e_tests.test_example + :members: + :undoc-members: + :show-inheritance: + +e2e\_tests.test\_points\_goal\_set module +----------------------------------------- + +.. automodule:: e2e_tests.test_points_goal_set + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: e2e_tests + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/edit_course.management.commands.rst b/docs/source/edit_course.management.commands.rst new file mode 100644 index 000000000..2a7d53f66 --- /dev/null +++ b/docs/source/edit_course.management.commands.rst @@ -0,0 +1,21 @@ +edit\_course.management.commands package +======================================== + +Submodules +---------- + +edit\_course.management.commands.reload\_course\_configuration module +--------------------------------------------------------------------- + +.. automodule:: edit_course.management.commands.reload_course_configuration + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: edit_course.management.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/edit_course.management.rst b/docs/source/edit_course.management.rst new file mode 100644 index 000000000..d796e00c6 --- /dev/null +++ b/docs/source/edit_course.management.rst @@ -0,0 +1,18 @@ +edit\_course.management package +=============================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + edit_course.management.commands + +Module contents +--------------- + +.. automodule:: edit_course.management + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/edit_course.migrations.rst b/docs/source/edit_course.migrations.rst new file mode 100644 index 000000000..57e180eb0 --- /dev/null +++ b/docs/source/edit_course.migrations.rst @@ -0,0 +1,10 @@ +edit\_course.migrations package +=============================== + +Module contents +--------------- + +.. automodule:: edit_course.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/edit_course.operations.rst b/docs/source/edit_course.operations.rst new file mode 100644 index 000000000..e3e112ad3 --- /dev/null +++ b/docs/source/edit_course.operations.rst @@ -0,0 +1,45 @@ +edit\_course.operations package +=============================== + +Submodules +---------- + +edit\_course.operations.batch module +------------------------------------ + +.. automodule:: edit_course.operations.batch + :members: + :undoc-members: + :show-inheritance: + +edit\_course.operations.clone module +------------------------------------ + +.. automodule:: edit_course.operations.clone + :members: + :undoc-members: + :show-inheritance: + +edit\_course.operations.configure module +---------------------------------------- + +.. automodule:: edit_course.operations.configure + :members: + :undoc-members: + :show-inheritance: + +edit\_course.operations.tests module +------------------------------------ + +.. automodule:: edit_course.operations.tests + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: edit_course.operations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/edit_course.rst b/docs/source/edit_course.rst new file mode 100644 index 000000000..f3ecf9b68 --- /dev/null +++ b/docs/source/edit_course.rst @@ -0,0 +1,80 @@ +edit\_course package +==================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + edit_course.management + edit_course.migrations + edit_course.operations + edit_course.templatetags + +Submodules +---------- + +edit\_course.course\_forms module +--------------------------------- + +.. automodule:: edit_course.course_forms + :members: + :undoc-members: + :show-inheritance: + +edit\_course.exercise\_forms module +----------------------------------- + +.. automodule:: edit_course.exercise_forms + :members: + :undoc-members: + :show-inheritance: + +edit\_course.managers module +---------------------------- + +.. automodule:: edit_course.managers + :members: + :undoc-members: + :show-inheritance: + +edit\_course.submission\_forms module +------------------------------------- + +.. automodule:: edit_course.submission_forms + :members: + :undoc-members: + :show-inheritance: + +edit\_course.tests module +------------------------- + +.. automodule:: edit_course.tests + :members: + :undoc-members: + :show-inheritance: + +edit\_course.urls module +------------------------ + +.. automodule:: edit_course.urls + :members: + :undoc-members: + :show-inheritance: + +edit\_course.views module +------------------------- + +.. automodule:: edit_course.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: edit_course + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/edit_course.templatetags.rst b/docs/source/edit_course.templatetags.rst new file mode 100644 index 000000000..5aceb00dd --- /dev/null +++ b/docs/source/edit_course.templatetags.rst @@ -0,0 +1,21 @@ +edit\_course.templatetags package +================================= + +Submodules +---------- + +edit\_course.templatetags.editcourse module +------------------------------------------- + +.. automodule:: edit_course.templatetags.editcourse + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: edit_course.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.api.csv.rst b/docs/source/exercise.api.csv.rst new file mode 100644 index 000000000..5e90398ab --- /dev/null +++ b/docs/source/exercise.api.csv.rst @@ -0,0 +1,53 @@ +exercise.api.csv package +======================== + +Submodules +---------- + +exercise.api.csv.aggregate\_points module +----------------------------------------- + +.. automodule:: exercise.api.csv.aggregate_points + :members: + :undoc-members: + :show-inheritance: + +exercise.api.csv.aggregate\_sheet module +---------------------------------------- + +.. automodule:: exercise.api.csv.aggregate_sheet + :members: + :undoc-members: + :show-inheritance: + +exercise.api.csv.submission\_sheet module +----------------------------------------- + +.. automodule:: exercise.api.csv.submission_sheet + :members: + :undoc-members: + :show-inheritance: + +exercise.api.csv.tests module +----------------------------- + +.. automodule:: exercise.api.csv.tests + :members: + :undoc-members: + :show-inheritance: + +exercise.api.csv.views module +----------------------------- + +.. automodule:: exercise.api.csv.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.api.csv + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.api.rst b/docs/source/exercise.api.rst new file mode 100644 index 000000000..4223bc92b --- /dev/null +++ b/docs/source/exercise.api.rst @@ -0,0 +1,69 @@ +exercise.api package +==================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + exercise.api.csv + +Submodules +---------- + +exercise.api.custom\_serializers module +--------------------------------------- + +.. automodule:: exercise.api.custom_serializers + :members: + :undoc-members: + :show-inheritance: + +exercise.api.full\_serializers module +------------------------------------- + +.. automodule:: exercise.api.full_serializers + :members: + :undoc-members: + :show-inheritance: + +exercise.api.mixins module +-------------------------- + +.. automodule:: exercise.api.mixins + :members: + :undoc-members: + :show-inheritance: + +exercise.api.serializers module +------------------------------- + +.. automodule:: exercise.api.serializers + :members: + :undoc-members: + :show-inheritance: + +exercise.api.tests module +------------------------- + +.. automodule:: exercise.api.tests + :members: + :undoc-members: + :show-inheritance: + +exercise.api.views module +------------------------- + +.. automodule:: exercise.api.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.cache.rst b/docs/source/exercise.cache.rst new file mode 100644 index 000000000..5c3144bbf --- /dev/null +++ b/docs/source/exercise.cache.rst @@ -0,0 +1,69 @@ +exercise.cache package +====================== + +Submodules +---------- + +exercise.cache.basetypes module +------------------------------- + +.. automodule:: exercise.cache.basetypes + :members: + :undoc-members: + :show-inheritance: + +exercise.cache.content module +----------------------------- + +.. automodule:: exercise.cache.content + :members: + :undoc-members: + :show-inheritance: + +exercise.cache.exceptions module +-------------------------------- + +.. automodule:: exercise.cache.exceptions + :members: + :undoc-members: + :show-inheritance: + +exercise.cache.exercise module +------------------------------ + +.. automodule:: exercise.cache.exercise + :members: + :undoc-members: + :show-inheritance: + +exercise.cache.hierarchy module +------------------------------- + +.. automodule:: exercise.cache.hierarchy + :members: + :undoc-members: + :show-inheritance: + +exercise.cache.invalidate\_util module +-------------------------------------- + +.. automodule:: exercise.cache.invalidate_util + :members: + :undoc-members: + :show-inheritance: + +exercise.cache.points module +---------------------------- + +.. automodule:: exercise.cache.points + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.cache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.management.commands.rst b/docs/source/exercise.management.commands.rst new file mode 100644 index 000000000..fa5ebddf7 --- /dev/null +++ b/docs/source/exercise.management.commands.rst @@ -0,0 +1,45 @@ +exercise.management.commands package +==================================== + +Submodules +---------- + +exercise.management.commands.export module +------------------------------------------ + +.. automodule:: exercise.management.commands.export + :members: + :undoc-members: + :show-inheritance: + +exercise.management.commands.export\_submissions module +------------------------------------------------------- + +.. automodule:: exercise.management.commands.export_submissions + :members: + :undoc-members: + :show-inheritance: + +exercise.management.commands.list\_exercises\_services module +------------------------------------------------------------- + +.. automodule:: exercise.management.commands.list_exercises_services + :members: + :undoc-members: + :show-inheritance: + +exercise.management.commands.tags module +---------------------------------------- + +.. automodule:: exercise.management.commands.tags + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.management.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.management.rst b/docs/source/exercise.management.rst new file mode 100644 index 000000000..aa8f81d45 --- /dev/null +++ b/docs/source/exercise.management.rst @@ -0,0 +1,18 @@ +exercise.management package +=========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + exercise.management.commands + +Module contents +--------------- + +.. automodule:: exercise.management + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.migrations.rst b/docs/source/exercise.migrations.rst new file mode 100644 index 000000000..84d4f66e2 --- /dev/null +++ b/docs/source/exercise.migrations.rst @@ -0,0 +1,421 @@ +exercise.migrations package +=========================== + +Submodules +---------- + +exercise.migrations.0001\_initial module +---------------------------------------- + +.. automodule:: exercise.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0002\_auto\_20150427\_1717 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0002_auto_20150427_1717 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0003\_auto\_20150617\_1014 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0003_auto_20150617_1014 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0004\_auto\_20150617\_1033 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0004_auto_20150617_1033 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0005\_auto\_20150625\_1821 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0005_auto_20150625_1821 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0006\_auto\_20150625\_1823 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0006_auto_20150625_1823 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0007\_auto\_20150625\_1835 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0007_auto_20150625_1835 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0008\_auto\_20150625\_1844 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0008_auto_20150625_1844 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0009\_auto\_20150721\_1152 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0009_auto_20150721_1152 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0010\_auto\_20151214\_1714 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0010_auto_20151214_1714 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0011\_auto\_20151218\_0857 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0011_auto_20151218_0857 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0012\_auto\_20151218\_0858 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0012_auto_20151218_0858 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0013\_auto\_20151222\_1320 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0013_auto_20151222_1320 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0014\_ltiexercise module +-------------------------------------------- + +.. automodule:: exercise.migrations.0014_ltiexercise + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0015\_auto\_20160124\_2139 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0015_auto_20160124_2139 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0016\_auto\_20160128\_1319 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0016_auto_20160128_1319 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0017\_auto\_20160205\_1026 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0017_auto_20160205_1026 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0018\_auto\_20160708\_1710 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0018_auto_20160708_1710 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0019\_auto\_20160825\_0601 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0019_auto_20160825_0601 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0020\_auto\_20160829\_0724 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0020_auto_20160829_0724 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0021\_auto\_20160905\_1335 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0021_auto_20160905_1335 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0022\_auto\_20160906\_1401 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0022_auto_20160906_1401 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0023\_learningobject\_content\_expire\_minutes module +------------------------------------------------------------------------- + +.. automodule:: exercise.migrations.0023_learningobject_content_expire_minutes + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0024\_auto\_20160919\_1951 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0024_auto_20160919_1951 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0025\_auto\_20170215\_0953 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0025_auto_20170215_0953 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0026\_auto\_20170428\_1213 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0026_auto_20170428_1213 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0027\_learningobject\_templates module +---------------------------------------------------------- + +.. automodule:: exercise.migrations.0027_learningobject_templates + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0028\_auto\_20180221\_1230 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0028_auto_20180221_1230 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0029\_ltiexercise\_open\_in\_iframe module +-------------------------------------------------------------- + +.. automodule:: exercise.migrations.0029_ltiexercise_open_in_iframe + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0030\_auto\_20180710\_1121 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0030_auto_20180710_1121 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0031\_exercisecollection module +--------------------------------------------------- + +.. automodule:: exercise.migrations.0031_exercisecollection + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0032\_ltiexercise\_service\_url module +---------------------------------------------------------- + +.. automodule:: exercise.migrations.0032_ltiexercise_service_url + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0033\_auto\_20190327\_1355 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0033_auto_20190327_1355 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0034\_auto\_20190416\_1133 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0034_auto_20190416_1133 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0035\_auto\_20190426\_1731 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0035_auto_20190426_1731 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0036\_auto\_20191024\_1303 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0036_auto_20191024_1303 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0037\_submission\_meta\_data module +------------------------------------------------------- + +.. automodule:: exercise.migrations.0037_submission_meta_data + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0038\_auto\_20210701\_1730 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0038_auto_20210701_1730 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0039\_auto\_20210812\_1536 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0039_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0040\_submission\_force\_exercise\_points module +-------------------------------------------------------------------- + +.. automodule:: exercise.migrations.0040_submission_force_exercise_points + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0041\_reveal\_rules module +---------------------------------------------- + +.. automodule:: exercise.migrations.0041_reveal_rules + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0042\_baseexercise\_grading\_mode module +------------------------------------------------------------ + +.. automodule:: exercise.migrations.0042_baseexercise_grading_mode + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0043\_submissiondraft module +------------------------------------------------ + +.. automodule:: exercise.migrations.0043_submissiondraft + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0044\_auto\_20220203\_2203 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0044_auto_20220203_2203 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0045\_auto\_20220211\_1540 module +----------------------------------------------------- + +.. automodule:: exercise.migrations.0045_auto_20220211_1540 + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0046\_pendingsubmission module +-------------------------------------------------- + +.. automodule:: exercise.migrations.0046_pendingsubmission + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0047\_lti1p3exercise module +----------------------------------------------- + +.. automodule:: exercise.migrations.0047_lti1p3exercise + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0048\_alter\_revealrule\_trigger module +----------------------------------------------------------- + +.. automodule:: exercise.migrations.0048_alter_revealrule_trigger + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0049\_submission\_unofficial\_submission\_type module +------------------------------------------------------------------------- + +.. automodule:: exercise.migrations.0049_submission_unofficial_submission_type + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0050\_submissiontagging module +-------------------------------------------------- + +.. automodule:: exercise.migrations.0050_submissiontagging + :members: + :undoc-members: + :show-inheritance: + +exercise.migrations.0051\_revealrule\_show\_zero\_points\_immediately module +---------------------------------------------------------------------------- + +.. automodule:: exercise.migrations.0051_revealrule_show_zero_points_immediately + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.protocol.rst b/docs/source/exercise.protocol.rst new file mode 100644 index 000000000..b36e69eac --- /dev/null +++ b/docs/source/exercise.protocol.rst @@ -0,0 +1,29 @@ +exercise.protocol package +========================= + +Submodules +---------- + +exercise.protocol.aplus module +------------------------------ + +.. automodule:: exercise.protocol.aplus + :members: + :undoc-members: + :show-inheritance: + +exercise.protocol.exercise\_page module +--------------------------------------- + +.. automodule:: exercise.protocol.exercise_page + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.protocol + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.rst b/docs/source/exercise.rst new file mode 100644 index 000000000..4f6396068 --- /dev/null +++ b/docs/source/exercise.rst @@ -0,0 +1,170 @@ +exercise package +================ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + exercise.api + exercise.cache + exercise.management + exercise.migrations + exercise.protocol + exercise.templatetags + +Submodules +---------- + +exercise.admin module +--------------------- + +.. automodule:: exercise.admin + :members: + :undoc-members: + :show-inheritance: + +exercise.async\_views module +---------------------------- + +.. automodule:: exercise.async_views + :members: + :undoc-members: + :show-inheritance: + +exercise.exercise\_models module +-------------------------------- + +.. automodule:: exercise.exercise_models + :members: + :undoc-members: + :show-inheritance: + +exercise.exercisecollection\_models module +------------------------------------------ + +.. automodule:: exercise.exercisecollection_models + :members: + :undoc-members: + :show-inheritance: + +exercise.forms module +--------------------- + +.. automodule:: exercise.forms + :members: + :undoc-members: + :show-inheritance: + +exercise.models module +---------------------- + +.. automodule:: exercise.models + :members: + :undoc-members: + :show-inheritance: + +exercise.permissions module +--------------------------- + +.. automodule:: exercise.permissions + :members: + :undoc-members: + :show-inheritance: + +exercise.reveal\_models module +------------------------------ + +.. automodule:: exercise.reveal_models + :members: + :undoc-members: + :show-inheritance: + +exercise.reveal\_states module +------------------------------ + +.. automodule:: exercise.reveal_states + :members: + :undoc-members: + :show-inheritance: + +exercise.sitemaps module +------------------------ + +.. automodule:: exercise.sitemaps + :members: + :undoc-members: + :show-inheritance: + +exercise.staff\_views module +---------------------------- + +.. automodule:: exercise.staff_views + :members: + :undoc-members: + :show-inheritance: + +exercise.submission\_models module +---------------------------------- + +.. automodule:: exercise.submission_models + :members: + :undoc-members: + :show-inheritance: + +exercise.tasks module +--------------------- + +.. automodule:: exercise.tasks + :members: + :undoc-members: + :show-inheritance: + +exercise.tests module +--------------------- + +.. automodule:: exercise.tests + :members: + :undoc-members: + :show-inheritance: + +exercise.tests\_cache module +---------------------------- + +.. automodule:: exercise.tests_cache + :members: + :undoc-members: + :show-inheritance: + +exercise.urls module +-------------------- + +.. automodule:: exercise.urls + :members: + :undoc-members: + :show-inheritance: + +exercise.viewbase module +------------------------ + +.. automodule:: exercise.viewbase + :members: + :undoc-members: + :show-inheritance: + +exercise.views module +--------------------- + +.. automodule:: exercise.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/exercise.templatetags.rst b/docs/source/exercise.templatetags.rst new file mode 100644 index 000000000..3fd19b9b7 --- /dev/null +++ b/docs/source/exercise.templatetags.rst @@ -0,0 +1,21 @@ +exercise.templatetags package +============================= + +Submodules +---------- + +exercise.templatetags.exercise module +------------------------------------- + +.. automodule:: exercise.templatetags.exercise + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: exercise.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/external_services.api.rst b/docs/source/external_services.api.rst new file mode 100644 index 000000000..f6e5d3f34 --- /dev/null +++ b/docs/source/external_services.api.rst @@ -0,0 +1,69 @@ +external\_services.api package +============================== + +Submodules +---------- + +external\_services.api.authentication module +-------------------------------------------- + +.. automodule:: external_services.api.authentication + :members: + :undoc-members: + :show-inheritance: + +external\_services.api.oauth\_nonce\_cache module +------------------------------------------------- + +.. automodule:: external_services.api.oauth_nonce_cache + :members: + :undoc-members: + :show-inheritance: + +external\_services.api.parsers module +------------------------------------- + +.. automodule:: external_services.api.parsers + :members: + :undoc-members: + :show-inheritance: + +external\_services.api.renderers module +--------------------------------------- + +.. automodule:: external_services.api.renderers + :members: + :undoc-members: + :show-inheritance: + +external\_services.api.serializers module +----------------------------------------- + +.. automodule:: external_services.api.serializers + :members: + :undoc-members: + :show-inheritance: + +external\_services.api.tests module +----------------------------------- + +.. automodule:: external_services.api.tests + :members: + :undoc-members: + :show-inheritance: + +external\_services.api.views module +----------------------------------- + +.. automodule:: external_services.api.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: external_services.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/external_services.management.commands.rst b/docs/source/external_services.management.commands.rst new file mode 100644 index 000000000..c0b014e1a --- /dev/null +++ b/docs/source/external_services.management.commands.rst @@ -0,0 +1,21 @@ +external\_services.management.commands package +============================================== + +Submodules +---------- + +external\_services.management.commands.configure\_external\_service\_from\_json module +-------------------------------------------------------------------------------------- + +.. automodule:: external_services.management.commands.configure_external_service_from_json + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: external_services.management.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/external_services.management.rst b/docs/source/external_services.management.rst new file mode 100644 index 000000000..51844c175 --- /dev/null +++ b/docs/source/external_services.management.rst @@ -0,0 +1,18 @@ +external\_services.management package +===================================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + external_services.management.commands + +Module contents +--------------- + +.. automodule:: external_services.management + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/external_services.migrations.rst b/docs/source/external_services.migrations.rst new file mode 100644 index 000000000..1706e2c09 --- /dev/null +++ b/docs/source/external_services.migrations.rst @@ -0,0 +1,165 @@ +external\_services.migrations package +===================================== + +Submodules +---------- + +external\_services.migrations.0001\_initial module +-------------------------------------------------- + +.. automodule:: external_services.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0002\_auto\_20150427\_1717 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0002_auto_20150427_1717 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0003\_menuitem\_access module +----------------------------------------------------------- + +.. automodule:: external_services.migrations.0003_menuitem_access + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0004\_auto\_20150828\_1210 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0004_auto_20150828_1210 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0005\_auto\_20160829\_1344 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0005_auto_20160829_1344 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0006\_ltiservice\_enable\_api\_access module +-------------------------------------------------------------------------- + +.. automodule:: external_services.migrations.0006_ltiservice_enable_api_access + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0007\_ltiservice\_access\_settings module +----------------------------------------------------------------------- + +.. automodule:: external_services.migrations.0007_ltiservice_access_settings + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0008\_auto\_20180724\_1445 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0008_auto_20180724_1445 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0009\_auto\_20180822\_1629 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0009_auto_20180822_1629 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0010\_auto\_20180918\_1916 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0010_auto_20180918_1916 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0011\_menuitem\_menu\_url module +-------------------------------------------------------------- + +.. automodule:: external_services.migrations.0011_menuitem_menu_url + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0012\_auto\_20201202\_1856 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0012_auto_20201202_1856 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0013\_auto\_20210414\_1146 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0013_auto_20210414_1146 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0014\_auto\_20210701\_1730 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0014_auto_20210701_1730 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0015\_auto\_20210812\_1536 module +--------------------------------------------------------------- + +.. automodule:: external_services.migrations.0015_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0016\_alter\_menuitem\_service module +------------------------------------------------------------------- + +.. automodule:: external_services.migrations.0016_alter_menuitem_service + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0017\_lti1p3service module +-------------------------------------------------------- + +.. automodule:: external_services.migrations.0017_lti1p3service + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0018\_alter\_menuitem\_menu\_url module +--------------------------------------------------------------------- + +.. automodule:: external_services.migrations.0018_alter_menuitem_menu_url + :members: + :undoc-members: + :show-inheritance: + +external\_services.migrations.0019\_alter\_linkservice\_destination\_region module +---------------------------------------------------------------------------------- + +.. automodule:: external_services.migrations.0019_alter_linkservice_destination_region + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: external_services.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/external_services.rst b/docs/source/external_services.rst new file mode 100644 index 000000000..ea00b3535 --- /dev/null +++ b/docs/source/external_services.rst @@ -0,0 +1,104 @@ +external\_services package +========================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + external_services.api + external_services.management + external_services.migrations + external_services.templatetags + +Submodules +---------- + +external\_services.admin module +------------------------------- + +.. automodule:: external_services.admin + :members: + :undoc-members: + :show-inheritance: + +external\_services.cache module +------------------------------- + +.. automodule:: external_services.cache + :members: + :undoc-members: + :show-inheritance: + +external\_services.forms module +------------------------------- + +.. automodule:: external_services.forms + :members: + :undoc-members: + :show-inheritance: + +external\_services.lti module +----------------------------- + +.. automodule:: external_services.lti + :members: + :undoc-members: + :show-inheritance: + +external\_services.lti1p3 module +-------------------------------- + +.. automodule:: external_services.lti1p3 + :members: + :undoc-members: + :show-inheritance: + +external\_services.models module +-------------------------------- + +.. automodule:: external_services.models + :members: + :undoc-members: + :show-inheritance: + +external\_services.permissions module +------------------------------------- + +.. automodule:: external_services.permissions + :members: + :undoc-members: + :show-inheritance: + +external\_services.tests module +------------------------------- + +.. automodule:: external_services.tests + :members: + :undoc-members: + :show-inheritance: + +external\_services.urls module +------------------------------ + +.. automodule:: external_services.urls + :members: + :undoc-members: + :show-inheritance: + +external\_services.views module +------------------------------- + +.. automodule:: external_services.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: external_services + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/external_services.templatetags.rst b/docs/source/external_services.templatetags.rst new file mode 100644 index 000000000..0c65f4810 --- /dev/null +++ b/docs/source/external_services.templatetags.rst @@ -0,0 +1,21 @@ +external\_services.templatetags package +======================================= + +Submodules +---------- + +external\_services.templatetags.external\_services module +--------------------------------------------------------- + +.. automodule:: external_services.templatetags.external_services + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: external_services.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 000000000..b59f8d007 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,23 @@ +.. A+ documentation master file, created by + sphinx-quickstart on Thu Mar 6 16:16:26 2025. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +A+ documentation +================ + +Add your content using ``reStructuredText`` syntax. See the +`reStructuredText `_ +documentation for details. + + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` \ No newline at end of file diff --git a/docs/source/inheritance.migrations.rst b/docs/source/inheritance.migrations.rst new file mode 100644 index 000000000..146812d19 --- /dev/null +++ b/docs/source/inheritance.migrations.rst @@ -0,0 +1,21 @@ +inheritance.migrations package +============================== + +Submodules +---------- + +inheritance.migrations.0001\_initial module +------------------------------------------- + +.. automodule:: inheritance.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: inheritance.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/inheritance.rst b/docs/source/inheritance.rst new file mode 100644 index 000000000..1714c4dc1 --- /dev/null +++ b/docs/source/inheritance.rst @@ -0,0 +1,29 @@ +inheritance package +=================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + inheritance.migrations + +Submodules +---------- + +inheritance.models module +------------------------- + +.. automodule:: inheritance.models + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: inheritance + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/lib.api.authentication.rst b/docs/source/lib.api.authentication.rst new file mode 100644 index 000000000..99db8a16f --- /dev/null +++ b/docs/source/lib.api.authentication.rst @@ -0,0 +1,21 @@ +lib.api.authentication package +============================== + +Submodules +---------- + +lib.api.authentication.grader module +------------------------------------ + +.. automodule:: lib.api.authentication.grader + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: lib.api.authentication + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/lib.api.rst b/docs/source/lib.api.rst new file mode 100644 index 000000000..8712e3636 --- /dev/null +++ b/docs/source/lib.api.rst @@ -0,0 +1,85 @@ +lib.api package +=============== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + lib.api.authentication + +Submodules +---------- + +lib.api.constants module +------------------------ + +.. automodule:: lib.api.constants + :members: + :undoc-members: + :show-inheritance: + +lib.api.core module +------------------- + +.. automodule:: lib.api.core + :members: + :undoc-members: + :show-inheritance: + +lib.api.fields module +--------------------- + +.. automodule:: lib.api.fields + :members: + :undoc-members: + :show-inheritance: + +lib.api.filters module +---------------------- + +.. automodule:: lib.api.filters + :members: + :undoc-members: + :show-inheritance: + +lib.api.mixins module +--------------------- + +.. automodule:: lib.api.mixins + :members: + :undoc-members: + :show-inheritance: + +lib.api.renderers module +------------------------ + +.. automodule:: lib.api.renderers + :members: + :undoc-members: + :show-inheritance: + +lib.api.serializers module +-------------------------- + +.. automodule:: lib.api.serializers + :members: + :undoc-members: + :show-inheritance: + +lib.api.statistics module +------------------------- + +.. automodule:: lib.api.statistics + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: lib.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/lib.cache.rst b/docs/source/lib.cache.rst new file mode 100644 index 000000000..5b6a0d430 --- /dev/null +++ b/docs/source/lib.cache.rst @@ -0,0 +1,53 @@ +lib.cache package +================= + +Submodules +---------- + +lib.cache.backends module +------------------------- + +.. automodule:: lib.cache.backends + :members: + :undoc-members: + :show-inheritance: + +lib.cache.cached module +----------------------- + +.. automodule:: lib.cache.cached + :members: + :undoc-members: + :show-inheritance: + +lib.cache.cached\_old module +---------------------------- + +.. automodule:: lib.cache.cached_old + :members: + :undoc-members: + :show-inheritance: + +lib.cache.tests module +---------------------- + +.. automodule:: lib.cache.tests + :members: + :undoc-members: + :show-inheritance: + +lib.cache.transact module +------------------------- + +.. automodule:: lib.cache.transact + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: lib.cache + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/lib.crypto.rst b/docs/source/lib.crypto.rst new file mode 100644 index 000000000..af24f5209 --- /dev/null +++ b/docs/source/lib.crypto.rst @@ -0,0 +1,29 @@ +lib.crypto package +================== + +Submodules +---------- + +lib.crypto.signed\_messages module +---------------------------------- + +.. automodule:: lib.crypto.signed_messages + :members: + :undoc-members: + :show-inheritance: + +lib.crypto.tests module +----------------------- + +.. automodule:: lib.crypto.tests + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: lib.crypto + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/lib.rst b/docs/source/lib.rst new file mode 100644 index 000000000..fa1ce7850 --- /dev/null +++ b/docs/source/lib.rst @@ -0,0 +1,183 @@ +lib package +=========== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + lib.api + lib.cache + lib.crypto + +Submodules +---------- + +lib.admin\_helpers module +------------------------- + +.. automodule:: lib.admin_helpers + :members: + :undoc-members: + :show-inheritance: + +lib.context\_processors module +------------------------------ + +.. automodule:: lib.context_processors + :members: + :undoc-members: + :show-inheritance: + +lib.email\_messages module +-------------------------- + +.. automodule:: lib.email_messages + :members: + :undoc-members: + :show-inheritance: + +lib.errors module +----------------- + +.. automodule:: lib.errors + :members: + :undoc-members: + :show-inheritance: + +lib.fields module +----------------- + +.. automodule:: lib.fields + :members: + :undoc-members: + :show-inheritance: + +lib.helpers module +------------------ + +.. automodule:: lib.helpers + :members: + :undoc-members: + :show-inheritance: + +lib.localization\_syntax module +------------------------------- + +.. automodule:: lib.localization_syntax + :members: + :undoc-members: + :show-inheritance: + +lib.logging module +------------------ + +.. automodule:: lib.logging + :members: + :undoc-members: + :show-inheritance: + +lib.middleware module +--------------------- + +.. automodule:: lib.middleware + :members: + :undoc-members: + :show-inheritance: + +lib.models module +----------------- + +.. automodule:: lib.models + :members: + :undoc-members: + :show-inheritance: + +lib.remote\_page module +----------------------- + +.. automodule:: lib.remote_page + :members: + :undoc-members: + :show-inheritance: + +lib.request\_globals module +--------------------------- + +.. automodule:: lib.request_globals + :members: + :undoc-members: + :show-inheritance: + +lib.sitemaps module +------------------- + +.. automodule:: lib.sitemaps + :members: + :undoc-members: + :show-inheritance: + +lib.storage module +------------------ + +.. automodule:: lib.storage + :members: + :undoc-members: + :show-inheritance: + +lib.testdata module +------------------- + +.. automodule:: lib.testdata + :members: + :undoc-members: + :show-inheritance: + +lib.tests module +---------------- + +.. automodule:: lib.tests + :members: + :undoc-members: + :show-inheritance: + +lib.typing module +----------------- + +.. automodule:: lib.typing + :members: + :undoc-members: + :show-inheritance: + +lib.validators module +--------------------- + +.. automodule:: lib.validators + :members: + :undoc-members: + :show-inheritance: + +lib.viewbase module +------------------- + +.. automodule:: lib.viewbase + :members: + :undoc-members: + :show-inheritance: + +lib.widgets module +------------------ + +.. automodule:: lib.widgets + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: lib + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/lti_tool.rst b/docs/source/lti_tool.rst new file mode 100644 index 000000000..ff36bdbc0 --- /dev/null +++ b/docs/source/lti_tool.rst @@ -0,0 +1,37 @@ +lti\_tool package +================= + +Submodules +---------- + +lti\_tool.urls module +--------------------- + +.. automodule:: lti_tool.urls + :members: + :undoc-members: + :show-inheritance: + +lti\_tool.utils module +---------------------- + +.. automodule:: lti_tool.utils + :members: + :undoc-members: + :show-inheritance: + +lti\_tool.views module +---------------------- + +.. automodule:: lti_tool.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: lti_tool + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/manage.rst b/docs/source/manage.rst new file mode 100644 index 000000000..776b9e348 --- /dev/null +++ b/docs/source/manage.rst @@ -0,0 +1,7 @@ +manage module +============= + +.. automodule:: manage + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules.rst b/docs/source/modules.rst new file mode 100644 index 000000000..9dda248ac --- /dev/null +++ b/docs/source/modules.rst @@ -0,0 +1,28 @@ +a-plus +====== + +.. toctree:: + :maxdepth: 4 + + api + aplus + apps + authorization + course + deviations + diploma + e2e_tests + edit_course + exercise + external_services + inheritance + lib + lti_tool + manage + news + notification + redirect_old_urls + shibboleth_login + site_alert + threshold + userprofile diff --git a/docs/source/news.migrations.rst b/docs/source/news.migrations.rst new file mode 100644 index 000000000..63c9ff63f --- /dev/null +++ b/docs/source/news.migrations.rst @@ -0,0 +1,53 @@ +news.migrations package +======================= + +Submodules +---------- + +news.migrations.0001\_initial module +------------------------------------ + +.. automodule:: news.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +news.migrations.0002\_remove\_news\_alert module +------------------------------------------------ + +.. automodule:: news.migrations.0002_remove_news_alert + :members: + :undoc-members: + :show-inheritance: + +news.migrations.0003\_alter\_news\_audience module +-------------------------------------------------- + +.. automodule:: news.migrations.0003_alter_news_audience + :members: + :undoc-members: + :show-inheritance: + +news.migrations.0004\_auto\_20210812\_1536 module +------------------------------------------------- + +.. automodule:: news.migrations.0004_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +news.migrations.0005\_news\_language module +------------------------------------------- + +.. automodule:: news.migrations.0005_news_language + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: news.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/news.rst b/docs/source/news.rst new file mode 100644 index 000000000..e2d55e114 --- /dev/null +++ b/docs/source/news.rst @@ -0,0 +1,70 @@ +news package +============ + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + news.migrations + news.templatetags + +Submodules +---------- + +news.admin module +----------------- + +.. automodule:: news.admin + :members: + :undoc-members: + :show-inheritance: + +news.cache module +----------------- + +.. automodule:: news.cache + :members: + :undoc-members: + :show-inheritance: + +news.forms module +----------------- + +.. automodule:: news.forms + :members: + :undoc-members: + :show-inheritance: + +news.models module +------------------ + +.. automodule:: news.models + :members: + :undoc-members: + :show-inheritance: + +news.urls module +---------------- + +.. automodule:: news.urls + :members: + :undoc-members: + :show-inheritance: + +news.views module +----------------- + +.. automodule:: news.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: news + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/news.templatetags.rst b/docs/source/news.templatetags.rst new file mode 100644 index 000000000..5ff36b35e --- /dev/null +++ b/docs/source/news.templatetags.rst @@ -0,0 +1,21 @@ +news.templatetags package +========================= + +Submodules +---------- + +news.templatetags.news module +----------------------------- + +.. automodule:: news.templatetags.news + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: news.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/notification.migrations.rst b/docs/source/notification.migrations.rst new file mode 100644 index 000000000..e0c81085f --- /dev/null +++ b/docs/source/notification.migrations.rst @@ -0,0 +1,61 @@ +notification.migrations package +=============================== + +Submodules +---------- + +notification.migrations.0001\_initial module +-------------------------------------------- + +.. automodule:: notification.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +notification.migrations.0002\_auto\_20160912\_1341 module +--------------------------------------------------------- + +.. automodule:: notification.migrations.0002_auto_20160912_1341 + :members: + :undoc-members: + :show-inheritance: + +notification.migrations.0003\_auto\_20160914\_1051 module +--------------------------------------------------------- + +.. automodule:: notification.migrations.0003_auto_20160914_1051 + :members: + :undoc-members: + :show-inheritance: + +notification.migrations.0004\_auto\_20190426\_1731 module +--------------------------------------------------------- + +.. automodule:: notification.migrations.0004_auto_20190426_1731 + :members: + :undoc-members: + :show-inheritance: + +notification.migrations.0005\_auto\_20210812\_1536 module +--------------------------------------------------------- + +.. automodule:: notification.migrations.0005_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +notification.migrations.0006\_notification\_regrade\_when\_seen module +---------------------------------------------------------------------- + +.. automodule:: notification.migrations.0006_notification_regrade_when_seen + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: notification.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/notification.rst b/docs/source/notification.rst new file mode 100644 index 000000000..905a2f29a --- /dev/null +++ b/docs/source/notification.rst @@ -0,0 +1,70 @@ +notification package +==================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + notification.migrations + notification.templatetags + +Submodules +---------- + +notification.admin module +------------------------- + +.. automodule:: notification.admin + :members: + :undoc-members: + :show-inheritance: + +notification.cache module +------------------------- + +.. automodule:: notification.cache + :members: + :undoc-members: + :show-inheritance: + +notification.models module +-------------------------- + +.. automodule:: notification.models + :members: + :undoc-members: + :show-inheritance: + +notification.tests module +------------------------- + +.. automodule:: notification.tests + :members: + :undoc-members: + :show-inheritance: + +notification.urls module +------------------------ + +.. automodule:: notification.urls + :members: + :undoc-members: + :show-inheritance: + +notification.views module +------------------------- + +.. automodule:: notification.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: notification + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/notification.templatetags.rst b/docs/source/notification.templatetags.rst new file mode 100644 index 000000000..777dafa55 --- /dev/null +++ b/docs/source/notification.templatetags.rst @@ -0,0 +1,21 @@ +notification.templatetags package +================================= + +Submodules +---------- + +notification.templatetags.notification module +--------------------------------------------- + +.. automodule:: notification.templatetags.notification + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: notification.templatetags + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/redirect_old_urls.rst b/docs/source/redirect_old_urls.rst new file mode 100644 index 000000000..acb584727 --- /dev/null +++ b/docs/source/redirect_old_urls.rst @@ -0,0 +1,37 @@ +redirect\_old\_urls package +=========================== + +Submodules +---------- + +redirect\_old\_urls.tests module +-------------------------------- + +.. automodule:: redirect_old_urls.tests + :members: + :undoc-members: + :show-inheritance: + +redirect\_old\_urls.urls module +------------------------------- + +.. automodule:: redirect_old_urls.urls + :members: + :undoc-members: + :show-inheritance: + +redirect\_old\_urls.views module +-------------------------------- + +.. automodule:: redirect_old_urls.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: redirect_old_urls + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/shibboleth_login.rst b/docs/source/shibboleth_login.rst new file mode 100644 index 000000000..24165ecfc --- /dev/null +++ b/docs/source/shibboleth_login.rst @@ -0,0 +1,61 @@ +shibboleth\_login package +========================= + +Submodules +---------- + +shibboleth\_login.apps module +----------------------------- + +.. automodule:: shibboleth_login.apps + :members: + :undoc-members: + :show-inheritance: + +shibboleth\_login.auth\_backend module +-------------------------------------- + +.. automodule:: shibboleth_login.auth_backend + :members: + :undoc-members: + :show-inheritance: + +shibboleth\_login.parser module +------------------------------- + +.. automodule:: shibboleth_login.parser + :members: + :undoc-members: + :show-inheritance: + +shibboleth\_login.tests module +------------------------------ + +.. automodule:: shibboleth_login.tests + :members: + :undoc-members: + :show-inheritance: + +shibboleth\_login.urls module +----------------------------- + +.. automodule:: shibboleth_login.urls + :members: + :undoc-members: + :show-inheritance: + +shibboleth\_login.views module +------------------------------ + +.. automodule:: shibboleth_login.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: shibboleth_login + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/site_alert.migrations.rst b/docs/source/site_alert.migrations.rst new file mode 100644 index 000000000..38d9437d2 --- /dev/null +++ b/docs/source/site_alert.migrations.rst @@ -0,0 +1,21 @@ +site\_alert.migrations package +============================== + +Submodules +---------- + +site\_alert.migrations.0001\_initial module +------------------------------------------- + +.. automodule:: site_alert.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: site_alert.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/site_alert.rst b/docs/source/site_alert.rst new file mode 100644 index 000000000..495126fa1 --- /dev/null +++ b/docs/source/site_alert.rst @@ -0,0 +1,45 @@ +site\_alert package +=================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + site_alert.migrations + +Submodules +---------- + +site\_alert.admin module +------------------------ + +.. automodule:: site_alert.admin + :members: + :undoc-members: + :show-inheritance: + +site\_alert.apps module +----------------------- + +.. automodule:: site_alert.apps + :members: + :undoc-members: + :show-inheritance: + +site\_alert.models module +------------------------- + +.. automodule:: site_alert.models + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: site_alert + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/threshold.migrations.rst b/docs/source/threshold.migrations.rst new file mode 100644 index 000000000..f42bc163d --- /dev/null +++ b/docs/source/threshold.migrations.rst @@ -0,0 +1,37 @@ +threshold.migrations package +============================ + +Submodules +---------- + +threshold.migrations.0001\_initial module +----------------------------------------- + +.. automodule:: threshold.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +threshold.migrations.0002\_alter\_threshold\_consume\_harder\_points module +--------------------------------------------------------------------------- + +.. automodule:: threshold.migrations.0002_alter_threshold_consume_harder_points + :members: + :undoc-members: + :show-inheritance: + +threshold.migrations.0003\_auto\_20210812\_1536 module +------------------------------------------------------ + +.. automodule:: threshold.migrations.0003_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: threshold.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/threshold.rst b/docs/source/threshold.rst new file mode 100644 index 000000000..460a77a1c --- /dev/null +++ b/docs/source/threshold.rst @@ -0,0 +1,53 @@ +threshold package +================= + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + threshold.migrations + +Submodules +---------- + +threshold.admin module +---------------------- + +.. automodule:: threshold.admin + :members: + :undoc-members: + :show-inheritance: + +threshold.models module +----------------------- + +.. automodule:: threshold.models + :members: + :undoc-members: + :show-inheritance: + +threshold.tests module +---------------------- + +.. automodule:: threshold.tests + :members: + :undoc-members: + :show-inheritance: + +threshold.views module +---------------------- + +.. automodule:: threshold.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: threshold + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/userprofile.api.rst b/docs/source/userprofile.api.rst new file mode 100644 index 000000000..f0136f1ba --- /dev/null +++ b/docs/source/userprofile.api.rst @@ -0,0 +1,45 @@ +userprofile.api package +======================= + +Submodules +---------- + +userprofile.api.full\_serializers module +---------------------------------------- + +.. automodule:: userprofile.api.full_serializers + :members: + :undoc-members: + :show-inheritance: + +userprofile.api.serializers module +---------------------------------- + +.. automodule:: userprofile.api.serializers + :members: + :undoc-members: + :show-inheritance: + +userprofile.api.tests module +---------------------------- + +.. automodule:: userprofile.api.tests + :members: + :undoc-members: + :show-inheritance: + +userprofile.api.views module +---------------------------- + +.. automodule:: userprofile.api.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: userprofile.api + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/userprofile.management.commands.rst b/docs/source/userprofile.management.commands.rst new file mode 100644 index 000000000..722740b89 --- /dev/null +++ b/docs/source/userprofile.management.commands.rst @@ -0,0 +1,37 @@ +userprofile.management.commands package +======================================= + +Submodules +---------- + +userprofile.management.commands.count\_active\_users module +----------------------------------------------------------- + +.. automodule:: userprofile.management.commands.count_active_users + :members: + :undoc-members: + :show-inheritance: + +userprofile.management.commands.delete\_users module +---------------------------------------------------- + +.. automodule:: userprofile.management.commands.delete_users + :members: + :undoc-members: + :show-inheritance: + +userprofile.management.commands.set\_superuser module +----------------------------------------------------- + +.. automodule:: userprofile.management.commands.set_superuser + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: userprofile.management.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/userprofile.management.rst b/docs/source/userprofile.management.rst new file mode 100644 index 000000000..874c088d9 --- /dev/null +++ b/docs/source/userprofile.management.rst @@ -0,0 +1,18 @@ +userprofile.management package +============================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + userprofile.management.commands + +Module contents +--------------- + +.. automodule:: userprofile.management + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/userprofile.migrations.rst b/docs/source/userprofile.migrations.rst new file mode 100644 index 000000000..eca351e2b --- /dev/null +++ b/docs/source/userprofile.migrations.rst @@ -0,0 +1,61 @@ +userprofile.migrations package +============================== + +Submodules +---------- + +userprofile.migrations.0001\_initial module +------------------------------------------- + +.. automodule:: userprofile.migrations.0001_initial + :members: + :undoc-members: + :show-inheritance: + +userprofile.migrations.0002\_auto\_20150427\_1717 module +-------------------------------------------------------- + +.. automodule:: userprofile.migrations.0002_auto_20150427_1717 + :members: + :undoc-members: + :show-inheritance: + +userprofile.migrations.0003\_auto\_20160728\_1139 module +-------------------------------------------------------- + +.. automodule:: userprofile.migrations.0003_auto_20160728_1139 + :members: + :undoc-members: + :show-inheritance: + +userprofile.migrations.0004\_auto\_20200721\_1422 module +-------------------------------------------------------- + +.. automodule:: userprofile.migrations.0004_auto_20200721_1422 + :members: + :undoc-members: + :show-inheritance: + +userprofile.migrations.0005\_userprofile\_organization module +------------------------------------------------------------- + +.. automodule:: userprofile.migrations.0005_userprofile_organization + :members: + :undoc-members: + :show-inheritance: + +userprofile.migrations.0006\_auto\_20210812\_1536 module +-------------------------------------------------------- + +.. automodule:: userprofile.migrations.0006_auto_20210812_1536 + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: userprofile.migrations + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/userprofile.rst b/docs/source/userprofile.rst new file mode 100644 index 000000000..6472a9a4e --- /dev/null +++ b/docs/source/userprofile.rst @@ -0,0 +1,95 @@ +userprofile package +=================== + +Subpackages +----------- + +.. toctree:: + :maxdepth: 4 + + userprofile.api + userprofile.management + userprofile.migrations + +Submodules +---------- + +userprofile.admin module +------------------------ + +.. automodule:: userprofile.admin + :members: + :undoc-members: + :show-inheritance: + +userprofile.models module +------------------------- + +.. automodule:: userprofile.models + :members: + :undoc-members: + :show-inheritance: + +userprofile.permissions module +------------------------------ + +.. automodule:: userprofile.permissions + :members: + :undoc-members: + :show-inheritance: + +userprofile.pseudonymize module +------------------------------- + +.. automodule:: userprofile.pseudonymize + :members: + :undoc-members: + :show-inheritance: + +userprofile.sitemaps module +--------------------------- + +.. automodule:: userprofile.sitemaps + :members: + :undoc-members: + :show-inheritance: + +userprofile.tests module +------------------------ + +.. automodule:: userprofile.tests + :members: + :undoc-members: + :show-inheritance: + +userprofile.urls module +----------------------- + +.. automodule:: userprofile.urls + :members: + :undoc-members: + :show-inheritance: + +userprofile.viewbase module +--------------------------- + +.. automodule:: userprofile.viewbase + :members: + :undoc-members: + :show-inheritance: + +userprofile.views module +------------------------ + +.. automodule:: userprofile.views + :members: + :undoc-members: + :show-inheritance: + +Module contents +--------------- + +.. automodule:: userprofile + :members: + :undoc-members: + :show-inheritance: diff --git a/edit_course/operations/tests.py b/edit_course/operations/tests.py index e67479e96..5e78b645d 100644 --- a/edit_course/operations/tests.py +++ b/edit_course/operations/tests.py @@ -465,11 +465,12 @@ def remove_exercise( """Remove exercise from the :param indices: a list of child indices to access the correct chapter. If the - exercise to be removed is at the top-level of the module, leave empty. If - it is under a chapter that is at the top-level of the module, include the - index of the chapter in the module. + exercise to be removed is at the top-level of the module, leave empty. If + it is under a chapter that is at the top-level of the module, include the + index of the chapter in the module. :param index: the index of the exercise to be removed. Can be a tuple to - indicate a range of indices, or None to remove the last exercise. + indicate a range of indices, or None to remove the last exercise. + """ if indices is None: indices = []