Building Documentation - genomizer/genomizer-documentation GitHub Wiki
The documentation repository contains a Makefile
that can be used to generate
separate parts of the entire technical documentation.
The targets that exist are:
-
main.pdf
: Generates the entire technical documentation. -
user-manual
: Generates the user-manual chapters. -
introduction
: Generates the front matter of the documentation (Chapters 1,2,3). -
deployment
: Generates chapters for deployment -
arch
: Generates chapters for architectual design. -
implementation
: Generates all implementation chapters. -
desktop-implement
: Generates implementation chapters for desktop. -
webb-implement
: Generates implementation chapters for web. -
android-implement
: Generates implementation chapters for android. -
ios-implement
: Generates implementation chapters for ios. -
server-implement
: Generates implementation chapters for server. -
id
: Generates all interaction design chapters. -
desktop-id
: Generates interaction design chapters for desktop. -
webb-id
: Generates interaction design chapters for web. -
android-id
: Generates interaction design chapters for android. -
ios-id
: Generates interaction design chapters for ios. -
sysdes
: Generates all chapters for system design. -
desktop-sysdes
: Generates system design chapter for desktop. -
webb-sysdes
: Generates system design chapter for webb. -
android-sysdes
: Generates system design chapter for android. -
webb-sysdes
: Generates system design chapter for webb. -
server-sysdes
: Generates system design chapter for server. -
user-stories
: Generate user-story appendix chapter. -
androidUML
: Generate android UML appendix chapter. -
servUML
: Generate server UML appendix chapter. -
api
: Generate api and server commands appendix chapter. -
issues
: Generate known problems chapter.
- Do a
git pull
. - Edit files in an editor(Not on writelatex/sharelatex).
- Test with the
make <command>
- Do a
add
,commit
andpush
. - Finished.
You will need to install a bunch of prerequisites to build the documentation. For example, on modern versions of Ubuntu you will need at least the following packages:
texlive
texlive-latex-recommended
texlive-latex-extra
texlive-fonts-recommended
latex-xcolor
pgf
lmodern