-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jan 21, 2025
1 parent
3e490ce
commit 48f651f
Showing
22 changed files
with
277 additions
and
279 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| {"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-21T21:45:51","documenter_version":"1.8.0"}} | ||
| {"documenter":{"julia_version":"1.11.2","generation_timestamp":"2025-01-21T21:57:18","documenter_version":"1.8.0"}} |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Documentation generation · Rimu.jl</title><meta name="title" content="Documentation generation · Rimu.jl"/><meta property="og:title" content="Documentation generation · Rimu.jl"/><meta property="twitter:title" content="Documentation generation · Rimu.jl"/><meta name="description" content="Documentation for Rimu.jl."/><meta property="og:description" content="Documentation for Rimu.jl."/><meta property="twitter:description" content="Documentation for Rimu.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"><a class="docs-logo" href="index.html"><img src="assets/logo.png" alt="Rimu.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="index.html">Rimu.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="index.html">Guide</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="generated/BHM-example.html">1D Bose-Hubbard Model</a></li><li><a class="tocitem" href="generated/BHM-example-mpi.html">Rimu with MPI</a></li><li><a class="tocitem" href="generated/G2-example.html">Calculating observables</a></li><li><a class="tocitem" href="generated/exact-example.html">Exact diagonalization</a></li><li><a class="tocitem" href="generated/HO-example.html">Degenerate perturbation theory in a harmonic oscillator basis</a></li></ul></li><li><span class="tocitem">User documentation</span><ul><li><a class="tocitem" href="exactdiagonalization.html">Exact Diagonalization</a></li><li><a class="tocitem" href="projectormontecarlo.html">Projector Monte Carlo</a></li><li><a class="tocitem" href="hamiltonians.html">Hamiltonians</a></li><li><a class="tocitem" href="statstools.html">StatsTools</a></li><li><a class="tocitem" href="mpi.html">Using MPI</a></li><li><a class="tocitem" href="custom_hamiltonians.html">Custom Hamiltonians</a></li></ul></li><li><span class="tocitem">Developer documentation</span><ul><li><a class="tocitem" href="interfaces.html">Interfaces</a></li><li><a class="tocitem" href="dictvectors.html">Dict vectors</a></li><li><a class="tocitem" href="addresses.html">BitString addresses</a></li><li><a class="tocitem" href="stochasticstyles.html">Stochastic styles</a></li><li><a class="tocitem" href="rimuio.html">I/O</a></li><li class="is-active"><a class="tocitem" href="documentation.html">Documentation generation</a><ul class="internal"><li><a class="tocitem" href="#Generating-the-documentation-web-site"><span>Generating the documentation web site</span></a></li><li><a class="tocitem" href="#Automatic-documentation-generation-and-deployment"><span>Automatic documentation generation and deployment</span></a></li></ul></li><li><a class="tocitem" href="testing.html">Code testing</a></li></ul></li><li><a class="tocitem" href="API.html">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">Developer documentation</a></li><li class="is-active"><a href="documentation.html">Documentation generation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="documentation.html">Documentation generation</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/RimuQMC/Rimu.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/RimuQMC/Rimu.jl/blob/develop/docs/src/documentation.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="Documentation-generation"><a class="docs-heading-anchor" href="#Documentation-generation">Documentation generation</a><a id="Documentation-generation-1"></a><a class="docs-heading-anchor-permalink" href="#Documentation-generation" title="Permalink"></a></h1><p>We are using <a href="https://github.com/JuliaDocs/Documenter.jl"><code>Documenter.jl</code></a> to generate the documentation web site based on markdown files stored in <code>docs/src</code>. Please help keeping the documentation up-to-date by editing the markdown files! For instructions on how to write appropriate documentation please refer to the relevant chapter in the Julia <a href="https://docs.julialang.org/en/v1/manual/documentation/">documentation</a> and the <code>Documenter.jl</code> <a href="https://juliadocs.github.io/Documenter.jl/latest/">documentation</a>.</p><h2 id="Generating-the-documentation-web-site"><a class="docs-heading-anchor" href="#Generating-the-documentation-web-site">Generating the documentation web site</a><a id="Generating-the-documentation-web-site-1"></a><a class="docs-heading-anchor-permalink" href="#Generating-the-documentation-web-site" title="Permalink"></a></h2><p>The documentation pages can be generated by running the build script by typing</p><pre><code class="nohighlight hljs">Rimu$ julia --project=docs docs/make.jl</code></pre><p>on the shell prompt from the <code>Rimu/</code> folder. A complete image of the static documentation web site will be generated in the folder <code>docs/build/</code>. It can be viewed locally by pointing a web browser to file <code>docs/build/index.html</code>, or by deploying it to the GitHub pages web server.</p><h2 id="Automatic-documentation-generation-and-deployment"><a class="docs-heading-anchor" href="#Automatic-documentation-generation-and-deployment">Automatic documentation generation and deployment</a><a id="Automatic-documentation-generation-and-deployment-1"></a><a class="docs-heading-anchor-permalink" href="#Automatic-documentation-generation-and-deployment" title="Permalink"></a></h2><p>Our documentation is hosted on GitHub pages. The documentation web site can be built and deployed automatically with GitHub Actions. This needs to be set up with an appropriate script in the file <code>.github/workflows/docs.yml</code>, where triggers for this to happen can be defined. In the current set up, a new documentation web site is generated and deployed whenever someone pushes to the develop branch on the GitHub server. The updated documentation can then be accessed <a href="https://RimuQMC.github.io/Rimu.jl/dev/">here</a>.</p><p>Previews for pull-requests can be accessed by replacing 101 in the following link with the PR number: <a href="https://RimuQMC.github.io/Rimu.jl/previews/PR101/">https://RimuQMC.github.io/Rimu.jl/previews/PR101/</a></p><h3 id="Example-scripts"><a class="docs-heading-anchor" href="#Example-scripts">Example scripts</a><a id="Example-scripts-1"></a><a class="docs-heading-anchor-permalink" href="#Example-scripts" title="Permalink"></a></h3><p>Examples should be added to the <code>scripts</code> folder, in the form of <code>.jl</code> files suitable for parsing by <a href="https://github.com/fredrikekre/Literate.jl"><code>Literate</code></a>. The process of generating documentation is automated in the <code>docs/make.jl</code> file and assumes that the following line is at (or near) the top of the script:</p><pre><code class="nohighlight hljs"># # Example N: Title</code></pre><p>where the number <code>N</code> and <code>Title</code> will be extracted automatically.</p><p>Tests for the results and output of specific scripts should be added at the end of each example. The code to run the test should be hidden from the final generated document by appending "#hide" to each line of testing code. For example,</p><pre><code class="nohighlight hljs">using Test #hide | ||
| @test isfile("result.out") #hide | ||
| @test result == expected_result #hide</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="rimuio.html">« I/O</a><a class="docs-footer-nextpage" href="testing.html">Code testing »</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.8.0 on <span class="colophon-date" title="Tuesday 21 January 2025 21:45">Tuesday 21 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> | ||
| @test result == expected_result #hide</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="rimuio.html">« I/O</a><a class="docs-footer-nextpage" href="testing.html">Code testing »</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.8.0 on <span class="colophon-date" title="Tuesday 21 January 2025 21:57">Tuesday 21 January 2025</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.