Merge pull request #58 from spacelab-ufsc/dev_doc

Release v0.2

.github/workflows/doc-build.yml

@@ -0,0 +1,32 @@
+name: Build LaTeX documentation
+
+on:
+  push:
+    branches: [dev_doc]
+  pull_request:
+    branches: [main, dev, dov_doc]
+
+jobs:
+  build_user_manual:
+    name: Build User Manual
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v2
+      - name: Compile LaTeX document
+        uses: xu-cheng/latex-action@v2
+        with:
+          working_directory: docs/user_manual
+          root_file: main.tex
+
+  build_pdr:
+    name: Build PDR
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Git repository
+        uses: actions/checkout@v2
+      - name: Compile LaTeX document
+        uses: xu-cheng/latex-action@v2
+        with:
+          working_directory: docs/pdr
+          root_file: main.tex

docs/user_manual/.gitignore

@@ -0,0 +1,276 @@
+## Core latex/pdflatex auxiliary files:
+*.aux
+*.lof
+*.log
+*.lot
+*.fls
+*.out
+*.toc
+*.fmt
+*.fot
+*.cb
+*.cb2
+.*.lb
+
+## Intermediate documents:
+*.dvi
+*.xdv
+*-converted-to.*
+# these rules might exclude image files for figures etc.
+# *.ps
+# *.eps
+# *.pdf
+
+## Generated if empty string is given at "Please type another file name for output:"
+.pdf
+
+## Bibliography auxiliary files (bibtex/biblatex/biber):
+*.bbl
+*.bcf
+*.blg
+*-blx.aux
+*-blx.bib
+*.run.xml
+
+## Build tool auxiliary files:
+*.fdb_latexmk
+*.synctex
+*.synctex(busy)
+*.synctex.gz
+*.synctex.gz(busy)
+*.pdfsync
+
+## Build tool directories for auxiliary files
+# latexrun
+latex.out/
+
+## Auxiliary and intermediate files from other packages:
+# algorithms
+*.alg
+*.loa
+
+# achemso
+acs-*.bib
+
+# amsthm
+*.thm
+
+# beamer
+*.nav
+*.pre
+*.snm
+*.vrb
+
+# changes
+*.soc
+
+# comment
+*.cut
+
+# cprotect
+*.cpt
+
+# elsarticle (documentclass of Elsevier journals)
+*.spl
+
+# endnotes
+*.ent
+
+# fixme
+*.lox
+
+# feynmf/feynmp
+*.mf
+*.mp
+*.t[1-9]
+*.t[1-9][0-9]
+*.tfm
+
+#(r)(e)ledmac/(r)(e)ledpar
+*.end
+*.?end
+*.[1-9]
+*.[1-9][0-9]
+*.[1-9][0-9][0-9]
+*.[1-9]R
+*.[1-9][0-9]R
+*.[1-9][0-9][0-9]R
+*.eledsec[1-9]
+*.eledsec[1-9]R
+*.eledsec[1-9][0-9]
+*.eledsec[1-9][0-9]R
+*.eledsec[1-9][0-9][0-9]
+*.eledsec[1-9][0-9][0-9]R
+
+# glossaries
+*.acn
+*.acr
+*.glg
+*.glo
+*.gls
+*.glsdefs
+*.lzo
+*.lzs
+
+# uncomment this for glossaries-extra (will ignore makeindex's style files!)
+# *.ist
+
+# gnuplottex
+*-gnuplottex-*
+
+# gregoriotex
+*.gaux
+*.gtex
+
+# htlatex
+*.4ct
+*.4tc
+*.idv
+*.lg
+*.trc
+*.xref
+
+# hyperref
+*.brf
+
+# knitr
+*-concordance.tex
+# TODO Comment the next line if you want to keep your tikz graphics files
+*.tikz
+*-tikzDictionary
+
+# listings
+*.lol
+
+# luatexja-ruby
+*.ltjruby
+
+# makeidx
+*.idx
+*.ilg
+*.ind
+
+# minitoc
+*.maf
+*.mlf
+*.mlt
+*.mtc[0-9]*
+*.slf[0-9]*
+*.slt[0-9]*
+*.stc[0-9]*
+
+# minted
+_minted*
+*.pyg
+
+# morewrites
+*.mw
+
+# nomencl
+*.nlg
+*.nlo
+*.nls
+
+# pax
+*.pax
+
+# pdfpcnotes
+*.pdfpc
+
+# sagetex
+*.sagetex.sage
+*.sagetex.py
+*.sagetex.scmd
+
+# scrwfile
+*.wrt
+
+# sympy
+*.sout
+*.sympy
+sympy-plots-for-*.tex/
+
+# pdfcomment
+*.upa
+*.upb
+
+# pythontex
+*.pytxcode
+pythontex-files-*/
+
+# tcolorbox
+*.listing
+
+# thmtools
+*.loe
+
+# TikZ & PGF
+*.dpth
+*.md5
+*.auxlock
+
+# todonotes
+*.tdo
+
+# vhistory
+*.hst
+*.ver
+
+# easy-todo
+*.lod
+
+# xcolor
+*.xcp
+
+# xmpincl
+*.xmpi
+
+# xindy
+*.xdy
+
+# xypic precompiled matrices and outlines
+*.xyc
+*.xyd
+
+# endfloat
+*.ttt
+*.fff
+
+# Latexian
+TSWLatexianTemp*
+
+## Editors:
+# WinEdt
+*.bak
+*.sav
+
+# Texpad
+.texpadtmp
+
+# LyX
+*.lyx~
+
+# Kile
+*.backup
+
+# gummi
+.*.swp
+
+# KBibTeX
+*~[0-9]*
+
+# auto folder when using emacs and auctex
+./auto/*
+*.el
+
+# expex forward references with \gathertags
+*-tags.tex
+
+# standalone packages
+*.sta
+
+# Makeindex log files
+*.lpz
+
+# Output folder
+build/

docs/user_manual/Makefile

@@ -0,0 +1,23 @@
+VERSION=v0.2
+SRC=main
+TARGET=slb-cam-doc-$(VERSION)
+
+ifndef BUILD_DIR
+	BUILD_DIR=build
+endif
+
+PDF_READER=evince
+
+all:
+	mkdir -p $(BUILD_DIR)
+	latexmk -pdf -jobname=$(BUILD_DIR)/$(TARGET) $(SRC).tex
+	cp -f $(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

docs/user_manual/README.md

@@ -0,0 +1,45 @@
+<h1 align="center">
+	SLCAM DOCUMENTATION
+	<br>
+</h1>
+
+<h4 align="center">Documentation of the SLCam Payload.</h4>
+
+<p align="center">
+    <a href="https://github.com/spacelab-ufsc/spacelab#versioning">
+        <img src="https://img.shields.io/badge/status-in%20development-red?style=for-the-badge">
+    </a>
+    <a href="https://github.com/spacelab-ufsc/slcam/releases">
+        <img alt="GitHub release (latest by date)" src="https://img.shields.io/github/v/release/spacelab-ufsc/slcam?style=for-the-badge">
+    </a>
+    <a href="https://github.com/spacelab-ufsc/slcam/releases">
+        <img alt="GitHub commits since latest release (by date) for a branch" src="https://img.shields.io/github/commits-since/spacelab-ufsc/slcam/latest/documentation?style=for-the-badge">
+    </a>
+    <a href="https://github.com/spacelab-ufsc/slcam/commits/master">
+        <img alt="GitHub last commit (branch)" src="https://img.shields.io/github/last-commit/spacelab-ufsc/slcam/documentation?style=for-the-badge">
+    </a>
+    <a href="https://github.com/spacelab-ufsc/slcam/issues">
+    	<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/spacelab-ufsc/slcam/documentation?style=for-the-badge">
+	</a>
+	<a href="">
+		<img src="https://img.shields.io/badge/DOC%20tool-LaTeX-yellow?style=for-the-badge">
+	</a>
+    <a href="https://github.com/spacelab-ufsc/slcam/actions">
+        <img src="https://img.shields.io/github/workflow/status/spacelab-ufsc/slcam/Build%20LaTeX%20documentation?style=for-the-badge">
+    </a>
+</p>
+
+<p align="center">
+	<a href="#dependencies">Dependencies</a> •
+	<a href="#generating-the-pdf-file">Generating the PDF file</a> •
+</p>
+
+## Dependencies
+
+- ```latexmk```
+
+## Generating the PDF file
+
+```
+make
+```

docs/user_manual/appendices/appendices.tex

@@ -0,0 +1,15 @@
+%
+% \brief Appendices.
+%
+% \author Gabriel Mariano Marcelino <gabriel.mm8@gmail.com>
+%
+% \version 0.2.0
+%
+% \date 2023/02/09
+%
+
+\begin{appendices}
+
+%\input{appendices/}
+
+\end{appendices}