Coding Standard

coding/Makefile

@@ -0,0 +1,23 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+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)
+
+# To make the version_management module visible while building the documentation
+export PYTHONPATH := $(SOURCEDIR):$(PYTHONPATH)

coding/conf.py

@@ -0,0 +1,59 @@
+# TemplateConfiguration file for the Sphinx documentation builder.
+
+from datetime import datetime
+from phoenixsystems.docsresources import latex_default
+
+project = "Phoenix RTOS DO-178C"
+copyright = "2025, Phoenix Systems"
+author = "Phoenix Systems"
+
+extensions = ["myst_parser", "sphinx_copybutton"]
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
+exclude_patterns = ["README", "_build", "Thumbs.db", ".DS_Store", "_venv"]
+
+latexpdf_title = "Software Code Standards"
+latexpdf_author = "Bartłomiej Paczek"
+latexpdf_reviewer = 'Kamil Ber'
+latexpdf_date = datetime.today().strftime('%d-%m-%Y')
+latexpdf_version = "Rev. 1.0"
+latexpdf_filename = "PHOENIX-RTOS-DO178-STD-0003-Software_Code_Standards"
+latexpdf_dochistory = r'''
+        \begin{table}[h!]
+        \centering
+        \color{ps-darkblue}
+        \begin{tabular}{p{1cm}|p{8cm}|p{3cm}|p{2cm}}
+        \hline
+        \textbf{Rev.} & \textbf{Description} & \textbf{Elaborated by} & \textbf{Date} \\
+        \hline
+        0.1 & Initial draft & B. Paczek & 2025-12-01 \\
+        \hline
+        \end{tabular}
+        \end{table}
+        '''
+
+latex_documents = [
+    ("index", f"{latexpdf_filename}.tex", latexpdf_title, author, "howto", False),
+]
+
+latex_engine = latex_default["engine"]
+latex_table_style = latex_default["table_style"]
+latex_additional_files = latex_default["additional_files"]
+
+# overwrite the maketitle element to use the variables from the current file
+modified_elements = latex_default["elements"].copy()
+modified_elements["maketitle"] = fr'''
+        \newcommand{{\doctitle}}{{{latexpdf_title}}}
+        \newcommand{{\docauthor}}{{{latexpdf_author}}}
+        \newcommand{{\docreviewer}}{{{latexpdf_reviewer}}}
+        \newcommand{{\docversion}}{{{latexpdf_version}}}
+        \newcommand{{\docdate}}{{{latexpdf_date}}}
+        \newcommand{{\dochistory}}{{{latexpdf_dochistory}}}
+
+    ''' + modified_elements["maketitle"]
+
+modified_elements["preamble"] = modified_elements["preamble"] + r'''\setcounter{secnumdepth}{1}'''
+latex_elements = modified_elements