Coverage for superdjango/contrib/support/__init__.py : 100%
Hot-keys on this page
r m x p toggle line displays
j k next/prev highlighted chunk
0 (zero) top of page
1 (one) first highlighted chunk
1"""
2Install
3-------
5Install requirements:
7.. code-block:: bash
9 pip install Markdown python-frontmatter pyyaml;
11Add ``superdjango.contrib.support.apps.DefaultConfig`` to ``INSTALLED_APPS``.
13Add the ``static`` directory to the ``STATICFILES_DIRS`` list:
15.. code-block:: python
17 STATICFILES_DIRS = [
18 # ...
19 os.path.join(BASE_DIR, "../help", "static"),
20 ]
22Optionally configure the following settings:
24.. code-block:: python
26 # Markdown extensions for rendering article content.
27 SUPERDJANGO_SUPPORT_MD_EXTENSIONS = ["extra"]
29 # The path to help content.
30 SUPERDJANGO_SUPPORT_PATH = os.path.join(BASE_DIR, "../help")
32 # Indicates whether unauthenticated users can access help content.
33 SUPERDJANGO_SUPPORT_REQUIRES_LOGIN = True
35 # Indicates search results should be logged. Helps improve the search catalog.
36 SUPERDJANGO_SUPPORT_SEARCH_LOG_RESULTS = True
38 # A list of terms that may be used to build the search catalog.
39 SUPERDJANGO_SUPPORT_SEARCH_TERMS = list()
41Add URLs:
43.. code-block:: python
45 urlpatterns = [
46 # ...
47 path('help/', include(superdjango.contrib.support.urls),
48 # ...
49 ]
51Usage
52-----
54Initialize help files and directories:
56Create the help directory in project root:
58.. code-block:: bash
60 ./manage.py init_support_dir;
62Customize the INI files and create content files as desired.
64"""
65__author__ = "Shawn Davis <shawn@superdjango.com>"
66__maintainer__ = "Shawn Davis <shawn@superdjango.com>"
67__version__ = "0.3.0-x"