Skip to content

Commit

Permalink
Added a bit more of documentation skeleton
Browse files Browse the repository at this point in the history
  • Loading branch information
AlvarBer committed Jan 11, 2017
1 parent aa5721b commit cdf52cd
Show file tree
Hide file tree
Showing 7 changed files with 28 additions and 15 deletions.
20 changes: 10 additions & 10 deletions docs/Makefile
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
PDF := persimmon.pdf # PDF Main Target
MARKDOWN := introduction.md state_of_the_art.md objectives.md risk_analysis.md \
# Markdown files
implementation.md postmortem.md # Markdown files
BODY := body.tex # Markdown files will be converted to this intermediate step
APPENDICES := appendixX.md # Markdown Appendices
APPENDIX := appendix.tex # And appendices to this intermediate step
#METADATA := metadata.yaml # Metadata files (Author, Date, Title, etc..)
#APPENDICES := appendixX.md # Markdown Appendices
#APPENDIX := appendix.tex # And appendices to this intermediate step
# METADATA := metadata.yaml # Metadata files (Author, Date, Title, etc..)
BIBLIOGRAPHY := persimmon.bib # BibLaTeX bibliography
CSL := emerald-harvard.csl # CSL file used for citations
TEMPLATE := template.tex # LaTeX template for producing PDF
Expand All @@ -16,25 +16,25 @@ IMAGES += $(GRAPHS:.tex=.pdf) # Generated PDF Images
all: $(PDF)

# Main PDF, travis ci and book to print version
$(PDF): $(BODY) $(APPENDIX) $(TEMPLATE) $(IMAGES) # TODO: Add abstract
$(PDF): $(BODY) $(TEMPLATE) $(IMAGES) # TODO: Add abstract
pandoc --smart --standalone --latex-engine xelatex --template $(TEMPLATE) \
--metadata author:"Álvaro Bermejo" \
--metadata date:"$(shell date +"%d/%m/%Y") ($(shell git descrive --abbrev=0 --tags))" \
--metadata date:"$(shell date +"%d/%m/%Y") ($(shell git describe --abbrev=0 --tags))" \
--metadata title:"Persimmon" --metadata fontsize:"12pt" --toc \
--metadata subtitle:"A scikitlearn visual programming interface" \
--metadata mainlang:"English" --metada keywords:"Machine Learning", "Visual Programming" \
--metadata mainlang:"English" --metada keywords:"Machine Learning","Visual Programming" \
--metadata papersize:"A4" --metadata sansfont:"Helvetica Neue LT Com" \
--metadata colorlinks --metadata documentclass:"scrreprt" \
--top-level-division chapter $(BODY) $(APPENDIX) -o $@
--top-level-division chapter $(BODY) -o $@

# Main PDF, travis ci and book to print version
travis: $(BODY) $(APPENDIX) $(TEMPLATE) $(IMAGES)
pandoc --smart --standalone --latex-engine xelatex --template $(TEMPLATE) \
--metadata author:"Álvaro Bermejo" \
--metadata date:"$(shell date +"%d/%m/%Y") ($(shell git descrive --abbrev=0 --tags))" \
--metadata date:"$(shell date +"%d/%m/%Y") ($(shell git describe --abbrev=0 --tags))" \
--metadata title:"Persimmon" --metadata fontsize:"12pt" --toc \
--metadata subtitle:"A sklearn visual programming interface" \
--metadata mainlang:"English" --metada keywords:"Machine Learning", "Visual Programming" \
--metadata mainlang:"English" --metada keywords:"Machine Learning","Visual Programming" \
--metadata papersize:"A4" \
--metadata colorlinks --metadata documentclass:"scrreprt" \
--chapters $(BODY) $(APPENDIX) -o $(PDF)
Expand Down
Binary file added docs/graphs/early_interface.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/graphs/filechooser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
11 changes: 11 additions & 0 deletions docs/implementation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
Implementation
==============

First Iteration
---------------

![Early "static" interface](graphs/early_interface.png)

![File chooser](graphs/filechooser.png)


6 changes: 6 additions & 0 deletions docs/postmortem.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Postmortem
==========

Bibliography
============

4 changes: 0 additions & 4 deletions docs/risk_analysis.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,3 @@ analysis of the capabilities of the platform must be done before starting the
project, identifying possible faults and providing possible solutions and or
alternatives.


Bibliography
============

2 changes: 1 addition & 1 deletion docs/template.tex
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@
\end{abstract}
$endif$

{\bfseries Keywords:}$for(keywords)$ $keywords$ $sep$, $endfor$.
{\bfseries Keywords:}$for(keywords)$ $keywords$ $sep$,$endfor$.

$for(include-before)$
$include-before$
Expand Down

0 comments on commit cdf52cd

Please sign in to comment.