Merge branch 'add-docs' into 'master'

Add docs

See merge request AlekSIS/official/AlekSIS-App-Hjelp!107

README.rst

@@ -19,8 +19,8 @@ Licence
 
 ::
 
+  Copyright © 2019, 2020, 2021, 2022 Jonathan Weth <dev@jonathanweth.de>
   Copyright © 2019, 2020, 2021 Julian Leucker <leuckeju@katharineum.de>
-  Copyright © 2019, 2020, 2021 Jonathan Weth <dev@jonathanweth.de>
   Copyright © 2019, 2020, 2021 Hangzhi Yu <yuha@katharineum.de>
   Copyright © 2019 Frank Poetzsch-Heffter <p-h@katharineum.de>
   Copyright © 2020 Dominik George <dominik.george@teckids.org>  

aleksis/apps/hjelp/apps.py

@@ -10,8 +10,8 @@ class HjelpConfig(AppConfig):
     }
     licence = "EUPL-1.2+"
     copyright_info = (
+        ([2019, 2020, 2021, 2022], "Jonathan Weth", "dev@jonathanweth.de"),
         ([2019, 2020, 2021], "Julian Leucker", "leuckeju@katharineum.de"),
-        ([2019, 2020, 2021], "Jonathan Weth", "dev@jonathanweth.de"),
         ([2019, 2020, 2021], "Hangzhi Yu", "yuha@katharineum.de"),
         ([2019], "Frank Poetzsch-Heffter", "p-h@katharineum.de"),
         ([2020], "Dominik George", "dominik.george@teckids.org"),

docs/Makefile

+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+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)

docs/admin/00_index.rst

+Support end users and get feedback with Hjelp
+=============================================
+
+.. toctree::
+   :glob:
+
+   *

docs/admin/10_managing_faqs.rst

+Managing FAQs
+=============
+
+Each operator can and must write their FAQs on their own.
+This is done on the page *Support → Manage FAQ*. First of all, FAQ sections need to be created.
+The form for this is accessible at the top of the page. For the section to be displayed,
+the *Show* checkbox must be selected.
+
+.. image:: ../_static/faq_section.png
+  :width: 100%
+  :alt: Form for FAQ sections
+
+Afterwards, questions (including answers) can be created.
+The corresponding section must be selected. Here, too, the *Show* checkbox is important.
+The text in the answer field can be formatted using HTML.
+All icons that can be selected are located on `Material Icons`_.
+
+.. image:: ../_static/faq_question.png
+  :width: 100%
+  :alt: Form for FAQ questions
+
+On the overview page, the order of the questions and answers can be changed.
+In addition, the sections can be edited here. Hidden sections and questions are displayed darker.
+
+.. image:: ../_static/manage_faq.png
+  :width: 100%
+  :alt: View for ordering and managing FAQs
+
+.. _Material Icons: https://material.io/resources/icons/

docs/admin/15_managing_issue_report_form.rst

+Managing issue report form
+==========================
+
+The Hjelp issue reporting system lets the operator categorize issues in a three-level model,
+whereby the used categories become more concrete from the first to the third level.
+Every category except the first-level ones that is created therefore has to refer to a so-called parent,
+of which it is a subcategory.
+
+Creating and managing categories is done in the backend admin
+interface under *AlekSIS — Hjelp (Support) → Issue categories*.
+
+.. image:: ../_static/issue_categories.png
+  :width: 100%
+  :alt: View for managing issue categories
+
+Upon using the *Add issue category* button, a form is displayed which contains
+all alterable attributes of the to-be category.
+
+The *Name* textbox contains the text displayed when the given category is shown;
+and by means of the *Parent category* dropdown select list,
+a parent category can be selected. In case no parent category is specified,
+the created category is on first level.
+
+If the *Free text input allowed* checkbox is selected,
+all possible children of the newly created category are ignored and instead,
+a free text input is displayed upon selection on the next level.
+One possible use case may be that the location of the selected issue has to be specified.
+
+Special attention has to be paid to the *Icon* and *Placeholder* options as they refer
+to the category select dropdown/free text input of the next level.
+All icons that can be selected are again located on `Material Icons`_.
+
+.. image:: ../_static/issue_category.png
+  :width: 100%
+  :alt: Issue category form
+
+.. _Material Icons: https://material.io/resources/icons/

docs/admin/40_preferences.rst

+Settings and preferences
+========================
+
+Hjelp requires mail delivery to be properly configured, as all three forms send their results via mail.
+To set the individual mail addresses the results are then sent to, one preference for each form exists:
+
+* **Recipient e-mail address for FAQ questions**
+* **Recipient e-mail address for issue reports**
+* **Recipient e-mail address for feedback**
+
+Additionally, using another preference, it can be configured whether it is possible for anonymous users
+to view the FAQ overview page:
+
+* **Public visibility of FAQ**

docs/conf.py

+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+import os
+import sys
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import django
+
+sys.path.insert(0, os.path.abspath(".."))
+os.environ["DJANGO_SETTINGS_MODULE"] = "aleksis.core.settings"
+os.environ["LOCAL_SETTINGS_FILE"] = os.path.abspath(os.path.join("..", "local.cfg"))
+django.setup()
+
+# -- Project information -----------------------------------------------------
+
+project = "AlekSIS-App-Hjelp"
+copyright = "2018-2022 The AlekSIS team"
+author = "The AlekSIS Team"
+
+# The short X.Y version
+version = "2.0"
+# The full version, including alpha/beta/rc tags
+release = "2.0.2.dev0"
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinxcontrib_django",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.viewcode",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_material"
+
+html_favicon = "../aleksis/core/static/img/aleksis-icon.png"
+html_logo = "../aleksis/core/static/img/aleksis-banner.svg"
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+html_theme_options = {
+    "repo_url": f"https://edugit.org/AlekSIS/official/{project}",
+    "repo_name": "EduGit",
+    "repo_type": "gitlab",
+    "theme_color": "#0d5eaf",
+    "color_primary": "#0d5eaf",
+    "color_accent": "#0d5eaf",
+    "globaltoc_depth": 2,
+    "globaltoc_collapse": False,
+}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+html_sidebars = {
+    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
+}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = f"{project}doc"
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, f"{project}.tex", f"{project} Documentation", author, "manual"),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "aleksis", f"{project} Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        project,
+        f"{project} Documentation",
+        author,
+        project,
+        "One line description of project.",
+        "Miscellaneous",
+    ),
+]
+
+
+# -- Options for Epub output -------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = project
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+
+# A unique identification for the text.
+#
+# epub_uid = ''
+
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for intersphinx extension ---------------------------------------
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {
+    "https://docs.python.org/": None,
+    "https://docs.djangoproject.com/en/stable": "https://docs.djangoproject.com/en/stable/_objects",
+}

docs/index.rst

+.. AlekSIS documentation master file, created by
+   sphinx-quickstart on Thu Aug 15 10:49:03 2019.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to AlekSIS-App-Chronos' documentation!
+==============================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   user/00_index
+   admin/00_index
+   dev/00_index
+   ref/00_index
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/make.bat

+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+if "%1" == "" goto help
+
+%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.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/user/00_index.rst

+Get support via Hjelp
+=====================
+
+.. toctree::
+   :glob:
+
+   *