Merge branch 'add-docs' into 'master'

[Docs] Add docs

See merge request AlekSIS/official/AlekSIS-App-DashboardFeeds!68

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

+Show data from external sources on dashboard
+============================================
+
+.. toctree::
+   :glob:
+
+   *

docs/admin/01_introduction.rst

+Introduction
+============
+
+AlekSIS provides dashboard widgets for displaying feeds from external resources.
+The following widgets are normal dashboard widgets and can be added and configured 
+like described in :ref:`core-configure-dashboard-widgets`.

docs/admin/10_rss_feed_widget.rst

+RSS feed widget
+===============
+
+This widget, unlike the name suggests, allows RSS, Atom and JSONFeed feeds to be parsed 
+and displayed on the dashboard. Only the most recent article is displayed, with a short caption 
+and optionally an image. For this, the feed must contain a JPG image as an enclosure 
+(this is not the case by default in every CMS, but most have plugins for this). 
+In addition, the news source is linked on the dashboard.
+
+* **RSS feed source URL**: The URL of the source feed
+* **Base URL**: The home or base URL of the news provider
+* **Text only**: With this being enabled, no images will be shown.
+
+.. note::
+
+    The RSS widget provides a task to pull data. The task ``get_feeds`` updates all active RSS feeds inside AlekSIS. 
+    We recommend to run the task every 5 to 10 minutes. The task is automatically scheduled every 10 minutes;
+    this can be changed as described in :ref:`core-periodic-tasks`.
+
+.. image:: ../_static/create_rss_widget.png
+  :width: 100%
+  :alt: Create a RSS widget
+
+.. image:: ../_static/rss_widget.png
+  :width: 400
+  :alt: The RSS widget on dashboard
+

docs/admin/11_ical_feed_widget.rst

+iCalendar feed widget
+=====================
+
+This widget displays the upcoming events of an online calendar on the dashboard. 
+The events are shown with their title and the exact date range.
+Calendar widgets that can't load or parse the calendar data will 
+be marked as broken. How to handle broken widgets is explained in :ref:`core-configure-dashboard-widgets`.
+
+* **iCalendar feed source URL**: The URL of the iCalendar feed
+* **Base URL**: The widget will have a link to visit a related website to see more events.
+* **Number of displayed counts**: With this option, you can configure how many events should be shown in the widget.
+
+.. image:: ../_static/create_ical_widget.png
+  :width: 100%
+  :alt: Create an iCalendar widget

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-DashboardFeeds"
+copyright = "2020-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.1.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

+Welcome to AlekSIS-App-DashboardFeeds' 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

pyproject.toml

@@ -44,7 +44,7 @@ ics = "^0.7"
 aleksis-core = "^2.0"
 
 [tool.poetry.dev-dependencies]
-aleksis-builddeps = "^5"
+aleksis-builddeps = "^6"
 
 [tool.poetry.plugins."aleksis.app"]
 dashboardfeeds = "aleksis.apps.dashboardfeeds.apps:DefaultConfig"