Skip to content

Commit

Permalink
build based on 0f4f9a2
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Dec 3, 2024
1 parent ea948d6 commit 44c1988
Show file tree
Hide file tree
Showing 21 changed files with 77 additions and 75 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.6","generation_timestamp":"2024-11-26T09:49:43","documenter_version":"1.6.0"}}
{"documenter":{"julia_version":"1.10.7","generation_timestamp":"2024-12-03T00:09:28","documenter_version":"1.6.0"}}
94 changes: 47 additions & 47 deletions dev/API/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/architecture/architecture/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/architecture/domain_and_resultsets/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,4 +76,4 @@
│ ├───relative_shelter_volume
│ ├───relative_taxa_cover
│ └───total_absolute_cover
└───site_data</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../architecture/">« Architectural overview</a><a class="docs-footer-nextpage" href="../../development/development_setup/">Development setup »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Tuesday 26 November 2024 09:49">Tuesday 26 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
└───site_data</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../architecture/">« Architectural overview</a><a class="docs-footer-nextpage" href="../../development/development_setup/">Development setup »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Tuesday 3 December 2024 00:09">Tuesday 3 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/dMCDA/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/development/building_docs/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Building Documentation · ADRIA.jl</title><meta name="title" content="Building Documentation · ADRIA.jl"/><meta property="og:title" content="Building Documentation · ADRIA.jl"/><meta property="twitter:title" content="Building Documentation · ADRIA.jl"/><meta name="description" content="Documentation for ADRIA.jl."/><meta property="og:description" content="Documentation for ADRIA.jl."/><meta property="twitter:description" content="Documentation for ADRIA.jl."/><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../search_index.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script><link href="../../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="ADRIA.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">ADRIA.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../../">Introduction</a></li><li><a class="tocitem" href="../../synopsis/">Synopsis</a></li><li><span class="tocitem">Usage</span><ul><li><a class="tocitem" href="../../usage/getting_started/">Getting Started</a></li><li><a class="tocitem" href="../../usage/domain/">Loading a Domain</a></li><li><a class="tocitem" href="../../usage/results/">Loading Results</a></li><li><a class="tocitem" href="../../usage/scenario_generation/">Generating scenarios</a></li><li><a class="tocitem" href="../../usage/scenario_runs/">Running scenarios</a></li><li><a class="tocitem" href="../../usage/analysis/">Analysis</a></li><li><a class="tocitem" href="../../usage/cookbook/">Cookbook examples</a></li></ul></li><li><a class="tocitem" href="../../dMCDA/">Dynamic Multi-Criteria Decision Analysis</a></li><li><span class="tocitem">Architecture</span><ul><li><a class="tocitem" href="../../architecture/architecture/">Architectural overview</a></li><li><a class="tocitem" href="../../architecture/domain_and_resultsets/">Inputs and Outputs</a></li></ul></li><li><span class="tocitem">Development</span><ul><li><a class="tocitem" href="../development_setup/">Development setup</a></li><li><a class="tocitem" href="../metrics/">Contributing a metric</a></li><li><a class="tocitem" href="../release_guide/">Release Guide</a></li><li class="is-active"><a class="tocitem" href>Building Documentation</a><ul class="internal"><li><a class="tocitem" href="#Building-documentation-locally"><span>Building documentation locally</span></a></li><li><a class="tocitem" href="#Documentation-deployment"><span>Documentation deployment</span></a></li></ul></li></ul></li><li><a class="tocitem" href="../../API/">ADRIA API</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">Development</a></li><li class="is-active"><a href>Building Documentation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Building Documentation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/open-AIMS/ADRIA.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/open-AIMS/ADRIA.jl/blob/main/docs/src/development/building_docs.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Building-Documentation"><a class="docs-heading-anchor" href="#Building-Documentation">Building Documentation</a><a id="Building-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Building-Documentation" title="Permalink"></a></h1><p>ADRIA documentation is built using <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a>.</p><h2 id="Building-documentation-locally"><a class="docs-heading-anchor" href="#Building-documentation-locally">Building documentation locally</a><a id="Building-documentation-locally-1"></a><a class="docs-heading-anchor-permalink" href="#Building-documentation-locally" title="Permalink"></a></h2><p>As the documentation is build from a separate environment, it must be maintained/updated to incorporate any changes to ADRIA.</p><pre><code class="language-bash hljs">$ julia --project=docs
(docs) pkg&gt; resolve
(docs) pkg&gt; up</code></pre><p>If no changes to the environment are necessary, simply run <code>make.jl</code> from the <code>docs</code> folder:</p><pre><code class="language-bash hljs">$ cd docs
$ julia --project=. make.jl</code></pre><p>Locally generated documentation can be found under <code>docs/build</code>. Open the <code>index.html</code> file with any web browser.</p><h2 id="Documentation-deployment"><a class="docs-heading-anchor" href="#Documentation-deployment">Documentation deployment</a><a id="Documentation-deployment-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation-deployment" title="Permalink"></a></h2><p>Documentation is hosted on <a href="https://pages.github.com/">GitHub Pages</a> via <a href="https://github.com/features/actions">GitHub Actions</a>.</p><p>Configuration is found <a href="https://github.com/open-AIMS/ADRIA.jl/blob/main/.github/workflows/documentation.yml">here</a>.</p><p>Documentation is automatically built and deployed:</p><ul><li>When a PR targeting <code>main</code> is submitted In this case, a preview URL is created: e.g., a URL with <code>previews/PR###</code> at the end, where <code>PR###</code> refers to the PR ID.</li><li>On commit/merge to <code>main</code> In this case the main documentation website is updated</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../release_guide/">« Release Guide</a><a class="docs-footer-nextpage" href="../../API/">ADRIA API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Tuesday 26 November 2024 09:49">Tuesday 26 November 2024</span>. Using Julia version 1.10.6.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
$ julia --project=. make.jl</code></pre><p>Locally generated documentation can be found under <code>docs/build</code>. Open the <code>index.html</code> file with any web browser.</p><h2 id="Documentation-deployment"><a class="docs-heading-anchor" href="#Documentation-deployment">Documentation deployment</a><a id="Documentation-deployment-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation-deployment" title="Permalink"></a></h2><p>Documentation is hosted on <a href="https://pages.github.com/">GitHub Pages</a> via <a href="https://github.com/features/actions">GitHub Actions</a>.</p><p>Configuration is found <a href="https://github.com/open-AIMS/ADRIA.jl/blob/main/.github/workflows/documentation.yml">here</a>.</p><p>Documentation is automatically built and deployed:</p><ul><li>When a PR targeting <code>main</code> is submitted In this case, a preview URL is created: e.g., a URL with <code>previews/PR###</code> at the end, where <code>PR###</code> refers to the PR ID.</li><li>On commit/merge to <code>main</code> In this case the main documentation website is updated</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../release_guide/">« Release Guide</a><a class="docs-footer-nextpage" href="../../API/">ADRIA API »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.6.0 on <span class="colophon-date" title="Tuesday 3 December 2024 00:09">Tuesday 3 December 2024</span>. Using Julia version 1.10.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 44c1988

Please sign in to comment.