Skip to content

Commit

Permalink
build based on 79ed285
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jul 11, 2024
1 parent 76479bc commit 5dfa18e
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 19 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.8.5","generation_timestamp":"2024-07-11T22:16:07","documenter_version":"1.5.0"}}
{"documenter":{"julia_version":"1.8.5","generation_timestamp":"2024-07-11T22:18:31","documenter_version":"1.5.0"}}
2 changes: 1 addition & 1 deletion dev/developer/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>Developer · QML.jl</title><meta name="title" content="Developer · QML.jl"/><meta property="og:title" content="Developer · QML.jl"/><meta property="twitter:title" content="Developer · QML.jl"/><meta name="description" content="Documentation for QML.jl."/><meta property="og:description" content="Documentation for QML.jl."/><meta property="twitter:description" content="Documentation for QML.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></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href="../">QML.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="../">QML</a></li><li class="is-active"><a class="tocitem" href>Developer</a><ul class="internal"><li><a class="tocitem" href="#Building-the-documentation-locally"><span>Building the documentation locally</span></a></li><li><a class="tocitem" href="#Contributing"><span>Contributing</span></a></li><li><a class="tocitem" href="#Creating-a-pull-request"><span>Creating a pull request</span></a></li><li><a class="tocitem" href="#Related-packages"><span>Related packages</span></a></li></ul></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 class="is-active"><a href>Developer</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Developer</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaGraphics/QML.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/JuliaGraphics/QML.jl/blob/main/docs/src/developer.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="Developer-documentation"><a class="docs-heading-anchor" href="#Developer-documentation">Developer documentation</a><a id="Developer-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-documentation" title="Permalink"></a></h1><h2 id="Building-the-documentation-locally"><a class="docs-heading-anchor" href="#Building-the-documentation-locally">Building the documentation locally</a><a id="Building-the-documentation-locally-1"></a><a class="docs-heading-anchor-permalink" href="#Building-the-documentation-locally" title="Permalink"></a></h2><p>If not mentioned otherwise I assume that you are using the <code>bash</code> terminal. On Windows you can install it using this software: <a href="https://gitforwindows.org/">Git for Windows</a> . Be careful: The included bash terminal is not fully compatible with the <a href="https://github.com/JuliaLang/juliaup">juliaup</a> Julia installer. If you are using <a href="https://github.com/JuliaLang/juliaup">juliaup</a> either use the <code>bash</code> terminal from VSCode, or install <a href="https://apps.microsoft.com/detail/windows-terminal/9N0DX20HK701">Windows Terminal</a>.</p><p>To build the documentation locally:</p><ul><li>add the package <code>TestEnv</code> to your global Julia environment <pre><code class="language-julia hljs">using Pkg
Pkg.add(&quot;TestEnv&quot;)</code></pre></li><li>create a fork of the QML.jl repository by going to <a href="https://github.com/JuliaGraphics/QML.jl">QML.jl</a> and</li></ul><p>clicking on the button &quot;Fork&quot; on the top right</p><ul><li>check it out locally using git, e.g. with the command <pre><code class="language-bash hljs">git clone https://github.com/USERNAME/QML.jl.git</code></pre>where USERNAME is your github user name.</li><li>navigate to the new folder <code>QML.jl</code> folder and start julia with <code>julia --project</code></li><li>instantiate the project with<pre><code class="language-julia hljs">using Pkg
Pkg.instantiate()</code></pre></li><li>activate the test environment with<pre><code class="language-julia hljs">using TestEnv; TestEnv.activate()</code></pre></li><li>now you can build and view the documentation with<pre><code class="language-julia hljs">using LiveServer
servedocs()</code></pre></li></ul><p>And click on the link <a href="http://localhost:8080">http://localhost:8080</a> to see the documentation.</p><h2 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h2><p>We need more people who help with improving the documentation, fixing bugs and with keeping the package up-to-date. You can see open documentation issues <a href="https://github.com/JuliaGraphics/QML.jl/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation">here</a>, open bugs <a href="https://github.com/JuliaGraphics/QML.jl/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug%22">here</a>, and there are of course also open feature requests and ideas to create a new add-on packages, e.g.</p><ul><li>a package for improved <a href="https://github.com/MakieOrg/Makie.jl">Makie</a> integration</li><li>a package for improved <a href="https://github.com/jheinen/GR.jl">GR</a> integration</li><li>a package for displaying and editing <a href="https://dataframes.juliadata.org/stable/">DataFrames</a></li></ul><p>You can get in touch with the current developers either on <a href="https://discourse.julialang.org/">Discourse</a> or via <a href="https://github.com/orgs/JuliaGraphics/discussions">JuliaGraphics</a>. </p><h2 id="Creating-a-pull-request"><a class="docs-heading-anchor" href="#Creating-a-pull-request">Creating a pull request</a><a id="Creating-a-pull-request-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-a-pull-request" title="Permalink"></a></h2><p>If you made changes to the documentation (or any change to the code), please push these changes to your fork and then create a pull request by clicking on the &quot;Contribute&quot; button on the github page of your fork. Before doing that make sure your fork is in sync with the main branch of QML.jl.</p><h2 id="Related-packages"><a class="docs-heading-anchor" href="#Related-packages">Related packages</a><a id="Related-packages-1"></a><a class="docs-heading-anchor-permalink" href="#Related-packages" title="Permalink"></a></h2><p>Some changes to QML.jl might require changes to one or more of the following, related packages:</p><ul><li><a href="https://github.com/barche/QmlJuliaExamples">https://github.com/barche/QmlJuliaExamples</a> Changes to QML.jl might require changes to the examples. Furthermore, when running the QML tests also these examples are executed, so changes to the examples might even brake these tests.</li><li><a href="https://github.com/JuliaGraphics/jlqml">https://github.com/JuliaGraphics/jlqml</a> This is the C++ interface package that glues Julia with the QT libraries.</li><li><a href="https://github.com/JuliaBinaryWrappers/Qt6Wayland_jll.jl">https://github.com/JuliaBinaryWrappers/Qt6Wayland_jll.jl</a> The only direct dependency on a (binary) jll package. There are many more indirect binary dependencies, mainly for the QT packages.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« QML</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.5.0 on <span class="colophon-date" title="Thursday 11 July 2024 22:16">Thursday 11 July 2024</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
servedocs()</code></pre></li></ul><p>And click on the link <a href="http://localhost:8080">http://localhost:8080</a> to see the documentation.</p><h2 id="Contributing"><a class="docs-heading-anchor" href="#Contributing">Contributing</a><a id="Contributing-1"></a><a class="docs-heading-anchor-permalink" href="#Contributing" title="Permalink"></a></h2><p>We need more people who help with improving the documentation, fixing bugs and with keeping the package up-to-date. You can see open documentation issues <a href="https://github.com/JuliaGraphics/QML.jl/issues?q=is%3Aopen+is%3Aissue+label%3Adocumentation">here</a>, open bugs <a href="https://github.com/JuliaGraphics/QML.jl/issues?q=is%3Aopen+is%3Aissue+label%3A%22bug%22">here</a>, and there are of course also open feature requests and ideas to create a new add-on packages, e.g.</p><ul><li>a package for improved <a href="https://github.com/MakieOrg/Makie.jl">Makie</a> integration</li><li>a package for improved <a href="https://github.com/jheinen/GR.jl">GR</a> integration</li><li>a package for displaying and editing <a href="https://dataframes.juliadata.org/stable/">DataFrames</a></li></ul><p>You can get in touch with the current developers either on <a href="https://discourse.julialang.org/">Discourse</a> or via <a href="https://github.com/orgs/JuliaGraphics/discussions">JuliaGraphics</a>. </p><h2 id="Creating-a-pull-request"><a class="docs-heading-anchor" href="#Creating-a-pull-request">Creating a pull request</a><a id="Creating-a-pull-request-1"></a><a class="docs-heading-anchor-permalink" href="#Creating-a-pull-request" title="Permalink"></a></h2><p>If you made changes to the documentation (or any change to the code), please push these changes to your fork and then create a pull request by clicking on the &quot;Contribute&quot; button on the github page of your fork. Before doing that make sure your fork is in sync with the main branch of QML.jl.</p><h2 id="Related-packages"><a class="docs-heading-anchor" href="#Related-packages">Related packages</a><a id="Related-packages-1"></a><a class="docs-heading-anchor-permalink" href="#Related-packages" title="Permalink"></a></h2><p>Some changes to QML.jl might require changes to one or more of the following, related packages:</p><ul><li><a href="https://github.com/barche/QmlJuliaExamples">https://github.com/barche/QmlJuliaExamples</a> Changes to QML.jl might require changes to the examples. Furthermore, when running the QML tests also these examples are executed, so changes to the examples might even brake these tests.</li><li><a href="https://github.com/JuliaGraphics/jlqml">https://github.com/JuliaGraphics/jlqml</a> This is the C++ interface package that glues Julia with the QT libraries.</li><li><a href="https://github.com/JuliaBinaryWrappers/Qt6Wayland_jll.jl">https://github.com/JuliaBinaryWrappers/Qt6Wayland_jll.jl</a> The only direct dependency on a (binary) jll package. There are many more indirect binary dependencies, mainly for the QT packages.</li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« QML</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.5.0 on <span class="colophon-date" title="Thursday 11 July 2024 22:18">Thursday 11 July 2024</span>. Using Julia version 1.8.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 5dfa18e

Please sign in to comment.