From 7351e94a11b7208af60eb91a5b06d091d6582390 Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Wed, 3 Dec 2014 20:34:06 +0100 Subject: [PATCH] doc: Decrease TOC depth This makes table of content shorter and the document is easier to navigate. --- doc/rpp_simulink.tex | 11 +++++------ rpp/blocks/scripts/doc_parse.py | 2 +- 2 files changed, 6 insertions(+), 7 deletions(-) diff --git a/doc/rpp_simulink.tex b/doc/rpp_simulink.tex index d536ac4..6048d95 100644 --- a/doc/rpp_simulink.tex +++ b/doc/rpp_simulink.tex @@ -53,7 +53,7 @@ \hypersetup{linkcolor=deepblue,} % Table of content depth -\setcounter{tocdepth}{4} +\setcounter{tocdepth}{2} % Landscape pages \usepackage{lscape} @@ -1574,12 +1574,11 @@ System blocks & High-Power output block & \textsc{X} & \textsc{[HOUT]} & \textsc \label{tab:block-lib-status} \end{table} -\subsection{Blocks implementation} \label{sec-blocks-implementation} -All of the blocks are implemented as a C Mex S-Function coded by hand. In this section the +All of the blocks are implemented as manually created C Mex S-Function . In this section the approach taken is briefly explained. -\subsubsection{C MEX S-Functions} +\subsection{C MEX S-Functions} \label{sec-c-mex-functions} \begin{compactitem} \item C : Implemented in C language. Other options are Fortran and Matlab language itself. @@ -1666,7 +1665,7 @@ cd /rpp/blocks/ compile_blocks() \end{lstlisting} -\subsubsection{Target Language Compiler files} +\subsection{Target Language Compiler files} \label{sec-target-language-compiler-files} In order to generate code for each one of the S-Functions, every S-Function implements a TLC file @@ -1729,7 +1728,7 @@ The file \textsc{$\langle$modelname$\rangle$.c} has 3 main functions: should never be called unless an error is detected and in most models it is empty. \end{compactitem} -\subsection{Blocks description} +\section{Block reference} \label{sec-blocks-description} This section describes each one of the Simulink blocks present in the Simulink diff --git a/rpp/blocks/scripts/doc_parse.py b/rpp/blocks/scripts/doc_parse.py index 669b524..86b02e6 100755 --- a/rpp/blocks/scripts/doc_parse.py +++ b/rpp/blocks/scripts/doc_parse.py @@ -66,7 +66,7 @@ def print_latex_desc(doc): return str +'\end{enumerate}' print("\\newpage\n") - print("\\subsubsection{%s}\n" % doc['Name']) + print("\\subsection{%s}\n" % doc['Name']) print("\\begin{description}\n") print("\\item[Inputs:] %s\n" % iodef_str(doc['Inputs'])) print("\\item[Outputs:] %s\n" % iodef_str(doc['Outputs'])) -- 2.39.2