Merge pull request #12 from spacelab-ufsc/doc

doc: Importing the documentation template #6

doc/Makefile

@@ -0,0 +1,23 @@
+SRC=main
+TARGET=pc104_adapter_doc
+
+ifndef BUILD_DIR
+	BUILD_DIR=build
+endif
+
+PDF_READER=evince
+
+all:
+	mkdir -p $(BUILD_DIR)
+	latexmk -pdf -jobname=$(BUILD_DIR)/$(TARGET) $(SRC).tex
+	rm -f $(TARGET).pdf
+	cp $(BUILD_DIR)/$(TARGET).pdf .
+
+index:
+	makeindex $(BUILD_DIR)/$(TARGET).nlo -s nomencl.ist -o $(BUILD_DIR)/$(TARGET).nls
+
+view:
+	$(PDF_READER) $(BUILD_DIR)/$(TARGET).pdf &
+
+clean:
+	rm $(BUILD_DIR)/* header/*.aux chapters/*.aux references/*.aux

doc/README.md

@@ -0,0 +1,12 @@
+# Documentation
+
+## Dependencies
+
+* ```latexmk```
+* ```texlive-epstopdf```
+
+## Generating the PDF file
+
+```
+make
+```

doc/chapters/introduction.tex

@@ -0,0 +1,27 @@
+%
+% introduction.tex
+%
+% Copyright (C) 2020 by SpaceLab.
+%
+% PC-104 Adapter Documentation
+%
+% This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+% International License. To view a copy of this license,
+% visit http://creativecommons.org/licenses/by-sa/4.0/.
+%
+
+%
+% \brief Introduction chapter.
+%
+% \author Gabriel Mariano Marcelino <gabriel.mm8@gmail.com>
+%
+% \institution Universidade Federal de Santa Catarina (UFSC)
+%
+% \version 0.1.0
+%
+% \date 2020/06/21
+%
+
+\chapter{Introduction} \label{ch:introduction}
+
+.

doc/chapters/references.tex

@@ -0,0 +1,27 @@
+%
+% references.tex
+%
+% Copyright (C) 2020 by SpaceLab.
+%
+% PC-104 Adapter Documentation
+%
+% This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+% International License. To view a copy of this license,
+% visit http://creativecommons.org/licenses/by-sa/4.0/.
+%
+
+%
+% \brief References chapter.
+%
+% \author Gabriel Mariano Marcelino <gabriel.mm8@gmail.com>
+%
+% \institution Universidade Federal de Santa Catarina (UFSC)
+%
+% \version 0.1.0
+%
+% \date 2020/06/21
+%
+
+%\bibliography{references/edc,references/obdh2}
+
+\addcontentsline{toc}{chapter}{References}

doc/header/authorpage.tex

@@ -0,0 +1,83 @@
+%
+% authorpage.tex
+%
+% Copyright (C) 2020 SpaceLab.
+%
+% PC-104 Adapter Documentation
+%
+% This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+% International License. To view a copy of this license,
+% visit http://creativecommons.org/licenses/by-sa/4.0/.
+%
+
+%
+% \brief Author page.
+%
+% \author Gabriel Mariano Marcelino <gabriel.mm8@gmail.com>
+%
+% \institution Universidade Federal de Santa Catarina (UFSC)
+%
+% \version 0.1.0
+%
+% \date 2020/06/21
+%
+
+\thispagestyle{empty}
+
+\begin{center}
+
+\textbf{\thetitle}
+
+\textit{June, 2020}
+
+\vspace{1cm}
+
+\textbf{Project Chief:}
+
+Eduardo Augusto Bezerra
+
+\vspace{1cm}
+
+\textbf{Authors:}
+
+Gabriel Mariano Marcelino \\
+
+\vspace{1cm}
+
+\textbf{Contributing Authors:}
+
+%Author 1 \\
+%Author 2 \\
+%Author 3 \\
+
+\vspace{1cm}
+
+
+\textbf{Revision Control:}
+
+\end{center}
+
+\begin{table}[!ht]
+    \begin{center}
+        \begin{tabular}{cL{5cm}L{5.5cm}C{2cm}}
+            \toprule[1.5pt]
+            \textbf{Version} & \textbf{Author}  & \textbf{Changes}    & \textbf{Date} \\
+            \midrule
+            0.1     & Gabriel M. Marcelino      & Document creation   & 2020/06/21 \\
+                    &                           &                     &            \\
+                    &                           &                     &            \\
+                    &                           &                     &            \\
+            \bottomrule[1.5pt]
+        \end{tabular}
+    \end{center}
+\end{table}
+
+\vfill
+
+\begin{figure}[!h]
+	\begin{center}
+		\includegraphics[width=0.25\textwidth]{figures/by-sa.eps}
+	\end{center}
+\end{figure}
+
+\textcopyright\  2020 by SpaceLab. \thetitle. This work is licensed under the Creative Commons Attribution-ShareAlike 4.0 International License. To view a copy of this license, visit \href{http://creativecommons.org/licenses/by-sa/4.0/}{http://creativecommons.org/licenses/by-sa/4.0/}.

doc/header/titlepage.tex

@@ -0,0 +1,58 @@
+%
+% titlepage.tex
+%
+% Copyright (C) 2020 by SpaceLab.
+%
+% PC-104 Adapter Documentation
+%
+% This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+% International License. To view a copy of this license,
+% visit http://creativecommons.org/licenses/by-sa/4.0/.
+%
+
+%
+% \brief Title page.
+%
+% \author Gabriel Mariano Marcelino <gabriel.mm8@gmail.com>
+%
+% \institution Universidade Federal de Santa Catarina (UFSC)
+%
+% \version 0.1.0
+%
+% \date 2020/06/21
+%
+
+\begin{titlepage}
+
+\thispagestyle{empty}
+
+\begin{flushleft}
+SPACELAB.PC104-ADAPTER.2020.06.001 REV A. ISSUE 0.1
+\end{flushleft}
+
+\begin{figure}[!ht]
+    \begin{flushleft}
+        \includegraphics[width=5cm]{figures/spacelab.png}
+    \end{flushleft}
+\end{figure}
+
+\begin{flushleft}
+\Huge{\textbf{\thetitle}}
+\rule[0pt]{\textwidth}{5pt}
+\end{flushleft}
+
+\vspace{0.2cm}
+
+\begin{flushleft}
+\textit{\thetitle} \\
+\textit{SpaceLab, Universidade Federal de Santa Catarina, Florianópolis - Brazil}
+\end{flushleft}
+
+\vfill
+\vfill
+
+\begin{flushright}
+June 2020
+\end{flushright}
+
+\end{titlepage}

doc/main.tex

@@ -0,0 +1,70 @@
+%
+% main.tex
+%
+% Copyright (C) 2020 by SpaceLab.
+%
+% PC-104 Adapter Documentation
+%
+% This work is licensed under the Creative Commons Attribution-ShareAlike 4.0
+% International License. To view a copy of this license,
+% visit http://creativecommons.org/licenses/by-sa/4.0/.
+%
+
+%
+% \brief Main file.
+%
+% \author Gabriel Mariano Marcelino <gabriel.mm8@gmail.com>
+%
+% \institution Universidade Federal de Santa Catarina (UFSC)
+%
+% \version 0.1.0
+%
+% \date 2020/06/21
+%
+
+\documentclass[a4paper,12pt]{book}
+
+\usepackage{spacelab_book}
+
+\title{PC-104 Adapter Documentation}
+\author{SpaceLab}
+\date{\today}
+
+% File metadata
+\hypersetup
+{
+    pdfauthor   = {SpaceLab},
+    pdfsubject  = {\thetitle},
+    pdftitle    = {\thetitle},
+    pdfkeywords = {Nanosatellites, Cubesats, GOLDS-UFSC}
+}
+
+\begin{document}
+
+    \pagenumbering{roman}
+    \setcounter{page}{1}
+
+    \input{header/titlepage}
+    \cleardoublepage
+    \input{header/authorpage}
+    \cleardoublepage
+
+    \listoffigures
+    \addcontentsline{toc}{chapter}{List of Figures}
+
+    \listoftables
+    \addcontentsline{toc}{chapter}{Lista of Tables}
+
+    \printnomenclature
+    \addcontentsline{toc}{chapter}{Nomenclature}
+
+    \tableofcontents
+    \cleardoublepage
+
+    \pagenumbering{arabic}
+    \setcounter{page}{1}
+
+    \input{chapters/introduction}
+    \input{chapters/references}
+
+\end{document}