Add tests

Improve documentation

Author: J-Christophe

cookiecutter.json

@@ -8,6 +8,7 @@
   "project_class_lib": "{{ cookiecutter.project_slug.title().replace('_', '') + 'Lib' }}",
   "project_short_description": "My Great Project description.",
   "year": "{% now 'utc', '%Y' %}",
+  "month": "{% now 'utc', '%B' %}",
   "_extensions": [
     "jinja2_time.TimeExtension"
   ],

{{cookiecutter.project_slug}}/Makefile

@@ -105,10 +105,10 @@ doc-pdf:
 	make doc && make latexpdf -C docs
 
 visu-doc-pdf:
-	make doc-pdf && acroread docs/build/latex/{{cookiecutter.project_slug}}.pdf
+	acroread docs/build/latex/{{cookiecutter.project_slug}}.pdf
 
 visu-doc:
-	make doc && firefox docs/build/html/index.html
+	firefox docs/build/html/index.html
 
 release:
 	python3 setup.py sdist

{{cookiecutter.project_slug}}/docs/source/_templates/layout.html

@@ -1,8 +1,8 @@
 {# Import the theme's layout. #}
-{% extends "!layout.html" %}
+{{ "{%" }} extends "!layout.html" {{ "%}" }}
 
 {# Add some extra stuff before and use existing with 'super()' call. #}
-{% block footer %}
+{{ "{%" }} block footer {{ "%}" }}
   <!--<h2>My footer of awesomeness.</h2>-->
-  {{ super() }}
-{% endblock %}
+  {{ "{{" }} super() {{ "}}" }}
+{{ "{%"}} endblock {{ "%}" }}

{{cookiecutter.project_slug}}/docs/source/conf.py

@@ -165,7 +165,7 @@ def setup(app):
         %%%%%%%%%%% datetime
         \usepackage{datetime}
 
-        \newdateformat{MonthYearFormat}{%
+        \newdateformat{MonthYearFormat}{{"{%"}}
             \monthname[\THEMONTH], \THEYEAR}
 
 
@@ -203,9 +203,9 @@ def setup(app):
         %%%%%%%%%%% Quote Styles at the top of chapter
         \usepackage{epigraph}
         \setlength{\epigraphwidth}{0.8\columnwidth}
-        \newcommand{\chapterquote}[2]{\epigraphhead[60]{\epigraph{\textit{#1}}{\textbf {\textit{--#2}}}}}
+        {{"\\newcommand{\chapterquote}[2]{\epigraphhead[60]{\epigraph{\textit{#1}}{\textbf {\textit{--#2}}}}}"}}
         %%%%%%%%%%% Quote for all places except Chapter
-        \newcommand{\sectionquote}[2]{{\quote{\textit{``#1''}}{\textbf {\textit{--#2}}}}}
+        {{"\\newcommand{\sectionquote}[2]{{\quote{\textit{``#1''}}{\textbf {\textit{--#2}}}}}"}}
     """,
     "maketitle": r"""
         \pagenumbering{Roman} %%% to avoid page 1 conflict with actual page 1
@@ -214,9 +214,7 @@ def setup(app):
             \centering
 
             \vspace*{40mm} %%% * is used to give space from top
-            \textbf{\Huge {"""
-    + title
-    + r"""}}
+            \textbf{\Huge {"""+title+ r"""}}
 
             \vspace{0mm}
             \begin{figure}[!h]
@@ -225,11 +223,9 @@ def setup(app):
             \end{figure}
 
             \vspace{0mm}
-            \Large \textbf{{"""
-    + author
-    + r"""}}
+            \Large \textbf{"""+author+ r"""}
 
-            \small Created on : November, 2021
+            \small Created on : {{ cookiecutter.month }}, {{ cookiecutter.year }}
 
             \vspace*{0mm}
             \small  Last updated : \MonthYearFormat\today

{{cookiecutter.project_slug}}/docs/source/conventions.rst

@@ -2,7 +2,7 @@
 Conventions
 ===========
 
-*The :term:`SUM` shall summarise symbols, stylistics conventions, and command
+*The* :term:`SUM` *shall summarise symbols, stylistics conventions, and command \
 syntax conventions used in the document.*
 
 .. note::

{{cookiecutter.project_slug}}/docs/source/external_view.rst

@@ -2,7 +2,7 @@
 External view of the software
 =============================
 
-*The :term:`SUM` shall identify the software files, including databases and data
-files, which are necessary for the software to operate, including security
-and privacy considerations for each file and identification of the software
+*The* :term:`SUM` *shall identify the software files, including databases and \
+data files, which are necessary for the software to operate, including security \
+and privacy considerations for each file and identification of the software \
 necessary to continue or resume operation in case of an emergency.*

{{cookiecutter.project_slug}}/docs/source/index.rst

@@ -1,5 +1,5 @@
 Welcome to {{ cookiecutter.project_name }}'s documentation!
-==================================
+===========================================================
 
 .. toctree::
    :maxdepth: 2

{{cookiecutter.project_slug}}/docs/source/introduction.rst

@@ -2,12 +2,14 @@
 Introduction
 ============
 
-*The :term:`SUM` shall contain a description of the purpose, objective, content
+*The *:term:`SUM` *shall contain a description of the purpose, objective, content \
 and the reason prompting its preparation.*
 
 Purpose
 -------
 
+.. automodule:: {{ cookiecutter.project_slug }}
+
 .. figure:: _static/logo.png
    :align: center
 

{{cookiecutter.project_slug}}/docs/source/old_modules.rst

@@ -5,73 +5,69 @@ Operations manual
 General
 -------
 
-*The :term:`SUM` shall contain the operational organisation, a reference schedule
-for each operational profile, the list of all the elementary operations to be
-carried out at the site, what to do in order to operate the site, the
-personnel responsible to do it and when.
+*The* :term:`SUM` *shall contain the operational organisation, a reference \
+schedule for each operational profile, the list of all the elementary \
+operations to be carried out at the site, what to do in order to operate the \
+site, the personnel responsible to do it and when.*
 
 
 Set‐up and initialisation
 -------------------------
 
-*The :term:`SUM` shall describe any procedures to be performed by the user in
-order to be identified or authorised to access or install software on the
-equipment, to perform the installation, to configure the software, to
-delete or overwrite former files or data, and to enter parameters for
-software operation.*
+*The* :term:`SUM` *shall describe any procedures to be performed by the user in \
+order to be identified or authorised to access or install software on the \
+equipment, to perform the installation, to configure the software, to delete \
+or overwrite former files or data, and to enter parameters for software \
+operation.*
 
 
 Getting started
 ---------------
 
-*The :term:`SUM` shall include the step‐by‐step procedures for beginning work,
-including any options available, and a check‐list for problem
-determination.*
+*The* :term:`SUM` *shall include the step‐by‐step procedures for beginning work, \
+including any options available, and a check‐list for problem determination.*
 
 
 Mode selection and control
 --------------------------
 
-The :term:`SUM` shall give an overview of the access and security features of the
-software that are visible to the user, and in particular:
+*The* :term:`SUM` *shall give an overview of the access and security features \
+of the software that are visible to the user, and in particular:*
 
 * How and from whom to obtain a password
 * How to add, delete, or change passwords under user control
-* Security and privacy considerations pertaining to the storage and
-marking of output reports and other media that the user can
-generate
+* Security and privacy considerations pertaining to the storage and marking of output reports and other media that the user can generate
 
 
 Normal operations
 -----------------
 
-*The :term:`SUM` shall identify the normal operations, to be performed by the
-user, for the use of software (function, menu, transaction, or other
-process being described), including description and options of menus,
-graphical icons, data entry forms, user inputs, inputs from other software
-or hardware that may affect the software’s interface with the user,
-outputs, diagnostic or error messages or alarms.*
+*The* :term:`SUM` *shall identify the normal operations, to be performed by the \
+user, for the use of software (function, menu, transaction, or other process \
+being described), including description and options of menus, graphical icons, \
+data entry forms, user inputs, inputs from other software or hardware that may \
+affect the software’s interface with the user, outputs, diagnostic or error \
+messages or alarms.*
 
 
 Normal termination
 ------------------
 
-*The :term:`SUM` shall describe how the user can cease or interrupt use of the
-software and how to determine whether normal termination or cessation
-has occurred.*
+*The* :term:`SUM` *shall describe how the user can cease or interrupt use of the \
+software and how to determine whether normal termination or cessation has \
+occurred.*
 
 
 Error conditions
 ----------------
 
-*The :term:`SUM` shall describe the common error conditions that can occur as a
-result of executing the function, and how to detect that the error has
-occurred.
+*The* :term:`SUM` *shall describe the common error conditions that can occur as a \
+result of executing the function, and how to detect that the error has occurred.*
 
 
 Recover runs
 ------------
 
-The :term:`SUM` shall include the detailed procedures for restart or recovery
-from errors or malfunctions occurring during processing and for
-ensuring continuity of operations in the event of emergencies.
+*The* :term:`SUM` *shall include the detailed procedures for restart or recovery \
+from errors or malfunctions occurring during processing and for ensuring \
+continuity of operations in the event of emergencies.*