Commit d6ed7c8b authored by Jerome Touvier's avatar Jerome Touvier
Browse files

documentation howto

parent a11ef8b7
......@@ -66,7 +66,7 @@ def is_valid_float(dimension, mini=sys.float_info.epsilon, maxi=sys.float_info.m
def is_valid_datetime(date):
for df in ("%Y-%m-%d", "%Y-%m-%dT%H:%M:%S", "%Y-%m-%dT%H:%M:%S.%f"):
try:
return datetime.strptime(date, df)
return datetime.strptime(date.replace("Z", ""), df)
except (ValueError, TypeError):
pass
......
### The HTML documentation located in "templates/" directory is generated as follows:
1) Modify your markdown files: USAGE_*.md
2) Run md2html.sh script:
bash md2html.sh "markdown file name" "html file name" "html page title"
### Examples:
bash md2html.sh USAGE_TIMESERIES_FR.md timeseries_doc.html "RESIF: RESIFWS: Timeseries Docs: v1"
bash md2html.sh USAGE_TIMESERIES_EN.md timeseries_doc_en.html "RESIF: RESIFWS: Timeseries Docs: v1"
bash md2html.sh USAGE_TIMESERIESPLOT_FR.md timeseriesplot_doc.html "RESIF: RESIFWS: Timeseriesplot Docs: v1"
bash md2html.sh USAGE_TIMESERIESPLOT_EN.md timeseriesplot_doc_en.html "RESIF: RESIFWS: Timeseriesplot Docs: v1"
### Requirements:
pandoc
README=$1
FILE=$2
TITLE=$3
pandoc -f markdown -t html -s "$README" -o "$FILE" --metadata title="$TITLE"
perl -i -0pe 's/__\*__/<strong>\*<\/strong>/s' $FILE
perl -i -0pe 's/loc=\–/loc=--/s' $FILE
perl -i -0pe 's/<header.*<\/header>/<p style="text-align:center;"> <img src=".\/static\/images\/logoresif.png" alt="logoresif" width="341" height="95"><\/p>/s' $FILE
if [[ $FILE == *doc.html ]] ; then
perl -i -0pe 's/<\/head>/<link rel="stylesheet" href=".\/static\/resifws.css"\/>
<a href=".\/local=en"> <img src=".\/static\/images\/en.png" alt="Français - Anglais"> <\/a>\n<\/head>/gms' $FILE
elif [[ $FILE == *doc_en.html ]] ; then
perl -i -0pe 's/<\/head>/<link rel="stylesheet" href=".\/static\/resifws.css"\/>
<a href=".\/local=fr"> <img src=".\/static\/images\/fr.png" alt="Anglais - Français"> <\/a>\n<\/head>/gms' $FILE
fi
# perl -i -0pe
# -i in-place
# -0 read entire file in one shot (without the multiline searches failed).
# -p run Perl code
# -e Perl will not look for a script filename in the argument list.
......@@ -15,7 +15,7 @@ except Exception:
app = Flask(__name__)
FMT = "[%(asctime)s] %(levelname)s [%(filename)s:%(lineno)d] [%(funcName)s] %(message)s"
LOGLEVEL = logging.INFO if os.environ.get("RUNMODE") == "prodution" else logging.DEBUG
LOGLEVEL = logging.INFO if os.environ.get("RUNMODE") == "production" else logging.DEBUG
logging.basicConfig(format=FMT, level=LOGLEVEL)
# ************************************************************************
......
......@@ -15,7 +15,7 @@ except Exception:
app = Flask(__name__)
FMT = "[%(asctime)s] %(levelname)s [%(filename)s:%(lineno)d] [%(funcName)s] %(message)s"
LOGLEVEL = logging.INFO if os.environ.get("RUNMODE") == "prodution" else logging.DEBUG
LOGLEVEL = logging.INFO if os.environ.get("RUNMODE") == "production" else logging.DEBUG
logging.basicConfig(format=FMT, level=LOGLEVEL)
# ************************************************************************
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment