Module documentation docstrings

This commit is contained in:
Philip Sargent
2020-07-18 16:23:54 +01:00
parent 90dfa516da
commit edd5a3efd9
10 changed files with 100 additions and 17 deletions

View File

@@ -1,6 +1,18 @@
import sys
import os
import urllib.parse
"""Settings for a troggle installation which may vary among different
installations: for development or deployment, in a docker image or
python virtual environment (venv), on ubuntu, debian or in Windows
System for Linux (WSL), on the main server or in the potato hut,
using SQLite or mariaDB.
It sets the directory locations for the major parts of the system so
that e.g. expofiles can be on a different filesystem.
This file is included at the end of the main troggle/settings.py file so that
it overwrites defaults in that file.
"""
# link 'localsettings.py' to localsettingsWSL.py for use on a Windows 10 machine running WSL1
print(" * importing troggle/localsettings.py")