|
7 | 7 |
|
8 | 8 | ## how it works: overview
|
9 | 9 |
|
10 |
| -- `.travis.yml` asks to start the doc project |
| 10 | +- `.github/workflows/ci.yml` asks to start the doc project |
11 | 11 | (installs R and dependencies like `PhyloPlots` & `Documenter`) and
|
12 | 12 | run `./docs/make.jl` after a successful test & build.
|
13 | 13 | - the julia script `docs/make.jl` has these steps:
|
@@ -42,11 +42,9 @@ is run in its own anonymous Modules.
|
42 | 42 |
|
43 | 43 | Some of these blocs may contain plots, which are going to be drawn during the
|
44 | 44 | process, requiring the use of `PhyloPlots` along with `RCall`. Hence,
|
45 |
| -before the doc is built, the script `.travis.yml` installs `R` on the server, |
| 45 | +before the doc is built, `.github/workflows/ci.yml` installs `R` on the server, |
46 | 46 | sets up the julia environment with dependencies like `PhyloPlots` before
|
47 | 47 | starting the build in itself.
|
48 |
| -Note that, for an unknown reason, `R` must be installed *outside* of (the former) `make.sh`, |
49 |
| -in the main body of `.travis.sh`. |
50 | 48 |
|
51 | 49 | ### Directory of the plots
|
52 | 50 |
|
@@ -130,116 +128,3 @@ big difference:
|
130 | 128 | The first version will look for a *section* header "blabla", to link to that section.
|
131 | 129 | The secon version will look for a *function* named "blabla",
|
132 | 130 | to link to the documentation for that function.
|
133 |
| - |
134 |
| -## earlier versions |
135 |
| - |
136 |
| -### weave |
137 |
| - |
138 |
| -[`Weave`](https://github.com/mpastell/Weave.jl) was used to format the |
139 |
| -documentation pages until PhyloNetworks v0.7.0 |
140 |
| -(see [v0.7.0 doc](http://crsl4.github.io/PhyloNetworks.jl/v0.7.0/)), |
141 |
| -and the saving of the plots on the Git repository was handled with an |
142 |
| -extra Travis environment variable DRAW_FIG. |
143 |
| -Instructions about this previous previous setup can be found in this very |
144 |
| -[docs/readme file, in v0.7.0](https://github.com/crsl4/PhyloNetworks.jl/blob/v0.7.0/docs/readme.md). |
145 |
| -An extra step used file [make_weave.jl](https://github.com/crsl4/PhyloNetworks.jl/blob/v0.7.0/docs/src/man/src/make_weave.jl). |
146 |
| - |
147 |
| -### mkdocs |
148 |
| - |
149 |
| -[MkDocs](http://www.mkdocs.org) was used to format the documentation pages until |
150 |
| -PhyloNetworks [v0.8.0](http://crsl4.github.io/PhyloNetworks.jl/v0.8.0/). |
151 |
| -For this: |
152 |
| -- `makedocs( ..., format = Markdown(), ...)` |
153 |
| - created vanilla "GitHub md" files only (no html conversion), |
154 |
| -- `deploydocs` called `mkdocs` to turn the markdown files in `docs/build/*.md` into html files: |
155 |
| - |
156 |
| - deploydocs( |
157 |
| - repo = ..., |
158 |
| - deps= Deps.pip("pygments", "mkdocs==0.17.5", "mkdocs-material==2.9.4", "python-markdown-math"), |
159 |
| - make = () -> run(`mkdocs build`), |
160 |
| - target = "site" # which files get copied to gh-pages |
161 |
| - ) |
162 |
| - |
163 |
| - problem: Travis uses python 2, but mkdocs v1.0 needs python 3. |
164 |
| - Versions of `mkdocs` and `mkdocs-material` specified manually to avoid conflicts, |
165 |
| - See https://discourse.julialang.org/t/mkdocs-material-in-documenter/13764/3 |
166 |
| -- In this conversion, the `mkdocs-material` package was used, for its "material" theme, |
167 |
| - via configuration in the `mkdocs.yml` file, in `docs/`: |
168 |
| - |
169 |
| - |
170 |
| -```yml |
171 |
| -# this is for MkDocs, to turn the .md files produced by Documenter into .html files |
172 |
| -site_name: PhyloNetworks.jl |
173 |
| -repo_url: https://github.com/crsl4/PhyloNetworks.jl |
174 |
| -site_description: PhyloNetworks is a Julia package for the manipulation, visualization and inference of phylogenetic networks. |
175 |
| -site_author: Claudia Solís-Lemus |
176 |
| - |
177 |
| -theme: |
178 |
| - name: 'material' |
179 |
| - palette: |
180 |
| - primary: 'teal' |
181 |
| - accent: 'teal' |
182 |
| - logo: 'snaq_small.png' |
183 |
| - |
184 |
| -extra_css: |
185 |
| - - assets/Documenter.css |
186 |
| - |
187 |
| -extra_javascript: |
188 |
| - - https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS_HTML |
189 |
| - - assets/mathjaxhelper.js |
190 |
| - |
191 |
| -markdown_extensions: |
192 |
| - - extra |
193 |
| - - tables |
194 |
| - - fenced_code |
195 |
| - - mdx_math |
196 |
| - - codehilite |
197 |
| - |
198 |
| -docs_dir: 'build' |
199 |
| - |
200 |
| -nav: |
201 |
| - - Home: index.md |
202 |
| - - Manual: |
203 |
| - - Installation: man/installation.md |
204 |
| - - Input Data for SNaQ: man/inputdata.md |
205 |
| - - TICR pipeline: man/ticr_howtogetQuartetCFs.md |
206 |
| - - Network estimation and display: man/snaq_plot.md |
207 |
| - - Network comparison and manipulation: man/dist_reroot.md |
208 |
| - - Candidate Networks: man/fixednetworkoptim.md |
209 |
| - - Extract Expected CFs: man/expectedCFs.md |
210 |
| - - Bootstrap: man/bootstrap.md |
211 |
| - - Multiple Alleles: man/multiplealleles.md |
212 |
| - - Continuous Trait Evolution: man/trait_tree.md |
213 |
| - - Parsimony on networks: man/parsimony.md |
214 |
| - - Library: |
215 |
| - - Public: lib/public.md |
216 |
| - - Internals: lib/internals.md |
217 |
| -``` |
218 |
| -
|
219 |
| -to check/install MkDocs: |
220 |
| -
|
221 |
| -```shell |
222 |
| -pip install --upgrade pip |
223 |
| -pip install --upgrade mkdocs |
224 |
| -pip install --upgrade mkdocs-material |
225 |
| -pip install --upgrade python-markdown-math |
226 |
| -``` |
227 |
| -and check the installed versions: |
228 |
| -(in comments are versions that work okay together): |
229 |
| -```shell |
230 |
| -python --version # Python 3.5.5 :: Anaconda, Inc. |
231 |
| -mkdocs --version # v0.17.4 v1.0.4 |
232 |
| -pip show mkdocs-material # v2.9.2 v3.2.0 |
233 |
| -pip show Pygments # v2.2.0 v2.3.1 |
234 |
| -pip show pymdown-extensions # v4.11 v4.11 |
235 |
| -pip show python-markdown-math # v0.6 v0.6 |
236 |
| -``` |
237 |
| - |
238 |
| -then use mkdocs to build the site. |
239 |
| -this step creates a `site/` directory with html files. |
240 |
| -they can be viewed at http://127.0.0.1:8000 (follow instructions) |
241 |
| - |
242 |
| -```shell |
243 |
| -mkdocs build |
244 |
| -mkdocs serve |
245 |
| -``` |
0 commit comments