Skip to content

Commit 469798b

Browse files
committed
add new pdf and script to build it
1 parent 3a1d928 commit 469798b

6 files changed

Lines changed: 29 additions & 10 deletions

File tree

doc/Back.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
2+
---
3+
title: |
4+
IQ-TREE version 3.0.0 - Tutorials and Manual
5+
Phylogenomic software by maximum likelihood
6+
7+
subtitle: "<http://www.iqtree.org>"
8+
author: |
9+
Bui Quang Minh, Rob Lanfear, Thomas Wong, Nhan Ly-Trong\
10+
Jana Trifinopoulos, Dominik Schrempf, Heiko A. Schmidt
11+
12+
date: May 2, 2025
13+
---
14+

doc/Compilation-Guide.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -338,3 +338,4 @@ Many developers in MacOS use Xcode to develop the code. To generate an XCode pro
338338
cmake -G Xcode <IQTREE_SOURCE_DIR>
339339

340340
This will generate a a subfolder `build-xcode/iqtree.xcodeproj`, which you can open in Xcode now.
341+

doc/Frequently-Asked-Questions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,3 +331,4 @@ iqtree3 -p FOLDER_NAME --out-aln OUTFILE_NAME --out-format NEXUS
331331
```
332332

333333
would output the alignment in nexus format.
334+

doc/Front.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,5 @@
11
---
22
layout: userdoc
3-
title: |
4-
IQ-TREE version 2.2.0: Tutorials and Manual
5-
Phylogenomic software by maximum likelihood
6-
7-
subtitle: "<http://www.iqtree.org>"
8-
author: |
9-
Bui Quang Minh, Rob Lanfear, Nhan Ly-Trong\
10-
Jana Trifinopoulos, Dominik Schrempf, Heiko A. Schmidt
11-
12-
date: March 25, 2022
133
keywords: [phylogenomic inference, maximum likelihood]
144
toc: true
155
papersize: A4

doc/build-doc.sh

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#! /bin/bash
2+
3+
dest_dir="."
4+
5+
files="Front.md Home.md Quickstart.md Web-Server-Tutorial.md Tutorial.md Advanced-Tutorial.md Assessing-Phylogenetic-Assumptions.md Concordance-Factor.md Dating.md Rootstrap.md AliSim.md Command-Reference.md Substitution-Models.md Complex-Models.md Polymorphism-Aware-Models.md Compilation-Guide.md Frequently-Asked-Questions.md Back.md"
6+
7+
#generate pdf
8+
cd $dest_dir
9+
pdf="iqtree-doc.pdf"
10+
cat $files | sed 's/]([a-zA-Z\-]*#/](#/g' | sed 's/(Quickstart)/(#getting-started)/g' | sed 's/(Web-Server-Tutorial)/(#web-server-tutorial)/g' | sed 's/(Tutorial)/(#beginners-tutorial)/g' | sed 's/(Advanced-Tutorial)/(#advanced-tutorial)/g' | sed 's/(Command-Reference)/(#command-reference)/g' | sed 's/(Substitution-Models)/(#substitution-models)/g' | sed 's/(Complex-Models)/(#complex-models)/g' | sed 's/(Polymorphism-Aware-Models)/(#polymorphism-aware-models)/g' | sed 's/(Compilation-Guide)/(#compilation-guide)/g' | sed 's/(Frequently-Asked-Questions)/(#frequently-asked-questions)/g' | sed 's/{:.*}//g' > iqtree-doc.md
11+
pandoc iqtree-doc.md --number-sections --listings --pdf-engine=xelatex -o $pdf
12+
echo "Generated $dest_dir/$pdf"
13+
rm iqtree-doc.md

doc/iqtree-doc.pdf

448 KB
Binary file not shown.

0 commit comments

Comments
 (0)