Skip to content

Commit b3e9185

Browse files
author
Documenter.jl
committed
build based on 27ab706
1 parent 4a403c3 commit b3e9185

File tree

8 files changed

+358
-346
lines changed

8 files changed

+358
-346
lines changed

julia-docs/dev/docstrings.html

Lines changed: 154 additions & 154 deletions
Large diffs are not rendered by default.

julia-docs/dev/index.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,7 @@ <h2 id="toc-title">On this page</h2>
194194
<li><a href="#sub-packages" id="toc-sub-packages" class="nav-link" data-scroll-target="#sub-packages">Sub Packages</a></li>
195195
<li><a href="#running-notebooks" id="toc-running-notebooks" class="nav-link" data-scroll-target="#running-notebooks">Running notebooks</a></li>
196196
<li><a href="#editing-documentation" id="toc-editing-documentation" class="nav-link" data-scroll-target="#editing-documentation">Editing Documentation</a></li>
197+
<li><a href="#how-to-cite" id="toc-how-to-cite" class="nav-link" data-scroll-target="#how-to-cite">How to Cite</a></li>
197198
</ul></li>
198199
</ul>
199200
<div class="toc-actions"><ul><li><a href="https://github.com/medyan-dev/MEDYAN.jl/edit/master/quartodocs/index.qmd" class="toc-action"><i class="bi bi-github"></i>Edit this page</a></li><li><a href="https://github.com/medyan-dev/MEDYAN.jl/issues/new" class="toc-action"><i class="bi empty"></i>Report an issue</a></li></ul></div></nav>
@@ -310,6 +311,10 @@ <h2 class="anchored" data-anchor-id="editing-documentation">Editing Documentatio
310311
<p>Run the following to refresh the docstrings for the site.</p>
311312
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb9"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="ex">julia</span> <span class="at">--project</span> <span class="at">-e</span> <span class="st">'using Pkg; Pkg.instantiate(workspace=true)'</span></span>
312313
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="ex">julia</span> <span class="at">--project</span><span class="op">=</span>docs docs/make-docstrings.jl</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
314+
</section>
315+
<section id="how-to-cite" class="level2">
316+
<h2 class="anchored" data-anchor-id="how-to-cite">How to Cite</h2>
317+
<p>If you use MEDYAN.jl in your research, please cite the relevant papers. See <a href="CITATION.bib">CITATION.bib</a> for BibTeX entries.</p>
313318

314319

315320
</section>

julia-docs/dev/medyan-tutorial.zip

-430 Bytes
Binary file not shown.

julia-docs/dev/search.json

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1593,7 +1593,7 @@
15931593
"href": "tutorials/1install.html",
15941594
"title": "1. Installing MEDYAN.jl",
15951595
"section": "",
1596-
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.12.2\nCommit ca9b6662be4 (2025-11-20 16:25 UTC)\nBuild Info:\n Official https://julialang.org release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-18.1.7 (ORCJIT, skylake)\n GC: Built with stock GC\nThreads: 1 default, 1 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner3/_work/_tool/julia/1.12.2/x64/bin/../lib/julia:/home/gh-actions1/actions-runner3/_work/_tool/julia/1.12.2/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.\n\n\n\nDownload the exact julia environment used to generate the tutorials.\nClick to Download\nNext extract this zip file and cd into the extracted directory.\nNext add a copy of MEDYAN to the directory.\nNow run:\njulia --project -e 'import Pkg; Pkg.instantiate()'\nTo start the julia REPL in the correct environment to run the tutorials, use:\njulia --project\nFrom inside the medyan-tutorial directory.\nYou can also save julia files in this directory and use the VSCode julia extension to set the environment, and run code blocks, if you prefer that over the REPL.\nhttps://code.visualstudio.com/docs/languages/julia\n\n\n\nThese tests may take a few minutes to run.\njulia lib/MEDYAN/test/install-deps.jl\njulia --project=lib/MEDYAN/test lib/MEDYAN/test/runtests.jl\nIf you have any errors or failing tests create an issue",
1596+
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.12.2\nCommit ca9b6662be4 (2025-11-20 16:25 UTC)\nBuild Info:\n Official https://julialang.org release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-18.1.7 (ORCJIT, skylake)\n GC: Built with stock GC\nThreads: 1 default, 1 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner6/_work/_tool/julia/1.12.2/x64/bin/../lib/julia:/home/gh-actions1/actions-runner6/_work/_tool/julia/1.12.2/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.\n\n\n\nDownload the exact julia environment used to generate the tutorials.\nClick to Download\nNext extract this zip file and cd into the extracted directory.\nNext add a copy of MEDYAN to the directory.\nNow run:\njulia --project -e 'import Pkg; Pkg.instantiate()'\nTo start the julia REPL in the correct environment to run the tutorials, use:\njulia --project\nFrom inside the medyan-tutorial directory.\nYou can also save julia files in this directory and use the VSCode julia extension to set the environment, and run code blocks, if you prefer that over the REPL.\nhttps://code.visualstudio.com/docs/languages/julia\n\n\n\nThese tests may take a few minutes to run.\njulia lib/MEDYAN/test/install-deps.jl\njulia --project=lib/MEDYAN/test lib/MEDYAN/test/runtests.jl\nIf you have any errors or failing tests create an issue",
15971597
"crumbs": [
15981598
"Tutorials",
15991599
"1. Installing MEDYAN.jl"
@@ -1604,7 +1604,7 @@
16041604
"href": "tutorials/1install.html#install-julia",
16051605
"title": "1. Installing MEDYAN.jl",
16061606
"section": "",
1607-
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.12.2\nCommit ca9b6662be4 (2025-11-20 16:25 UTC)\nBuild Info:\n Official https://julialang.org release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-18.1.7 (ORCJIT, skylake)\n GC: Built with stock GC\nThreads: 1 default, 1 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner3/_work/_tool/julia/1.12.2/x64/bin/../lib/julia:/home/gh-actions1/actions-runner3/_work/_tool/julia/1.12.2/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.",
1607+
"text": "MEDYAN.jl is a julia package so first install the julia programming language.\nThis tutorial was generated using:\n\n\nJulia Version 1.12.2\nCommit ca9b6662be4 (2025-11-20 16:25 UTC)\nBuild Info:\n Official https://julialang.org release\nPlatform Info:\n OS: Linux (x86_64-linux-gnu)\n CPU: 16 × Intel(R) Core(TM) i7-10700KF CPU @ 3.80GHz\n WORD_SIZE: 64\n LLVM: libLLVM-18.1.7 (ORCJIT, skylake)\n GC: Built with stock GC\nThreads: 1 default, 1 interactive, 1 GC (on 16 virtual cores)\nEnvironment:\n LD_LIBRARY_PATH = /home/gh-actions1/actions-runner6/_work/_tool/julia/1.12.2/x64/bin/../lib/julia:/home/gh-actions1/actions-runner6/_work/_tool/julia/1.12.2/x64/bin/../lib\n JULIA_PROJECT = @.\n JULIA_LOAD_PATH = @:@stdlib\n\n\nThe tutorials should work on newer versions of julia, and on MacOS and Windows, please create an issue if you have a problem or question.\nJulia can be installed with juliaup.\nYou can also download julia here.\nDo not install julia using apt install julia or module load julia, as these don’t have a recent version of julia.\nAfter installing julia, open the REPL with the julia command in terminal.",
16081608
"crumbs": [
16091609
"Tutorials",
16101610
"1. Installing MEDYAN.jl"
@@ -1787,6 +1787,13 @@
17871787
"section": "Editing Documentation",
17881788
"text": "Editing Documentation\nPreviewing docs requires Linux.\nRun the following to set up the environment and create a preview. Any changes to files in docs should auto update.\njulia --project -e 'using Pkg; Pkg.instantiate(workspace=true)'\n./docs/make.jl\nor\njulia --project -e 'using Pkg; Pkg.instantiate(workspace=true)'\njulia --project=docs docs/make.jl\nRun the following to refresh the docstrings for the site.\njulia --project -e 'using Pkg; Pkg.instantiate(workspace=true)'\njulia --project=docs docs/make-docstrings.jl"
17891789
},
1790+
{
1791+
"objectID": "index.html#how-to-cite",
1792+
"href": "index.html#how-to-cite",
1793+
"title": "MEDYAN.jl",
1794+
"section": "How to Cite",
1795+
"text": "How to Cite\nIf you use MEDYAN.jl in your research, please cite the relevant papers. See CITATION.bib for BibTeX entries."
1796+
},
17901797
{
17911798
"objectID": "reference/index.html",
17921799
"href": "reference/index.html",

0 commit comments

Comments
 (0)