-
Notifications
You must be signed in to change notification settings - Fork 20
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
Mar 28, 2024
1 parent
7ad98a1
commit 306f9f6
Showing
18 changed files
with
38 additions
and
36 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.9.4","generation_timestamp":"2024-03-25T13:58:28","documenter_version":"1.3.0"}} | ||
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2024-03-28T16:50:03","documenter_version":"1.3.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.
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.
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 |
---|---|---|
@@ -0,0 +1,2 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Reporting · Dynare.jl</title><meta name="title" content="Reporting · Dynare.jl"/><meta property="og:title" content="Reporting · Dynare.jl"/><meta property="twitter:title" content="Reporting · Dynare.jl"/><meta name="description" content="Documentation for Dynare.jl."/><meta property="og:description" content="Documentation for Dynare.jl."/><meta property="twitter:description" content="Documentation for Dynare.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/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="../../">Dynare.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="../../">Home</a></li><li><a class="tocitem" href="../../installation-and-configuration/">Installation and Configuration</a></li><li><a class="tocitem" href="../../running-dynare/">Running Dynare</a></li><li><span class="tocitem">Model File</span><ul><li><a class="tocitem" href="../syntax-elements/">Syntax elements</a></li><li><a class="tocitem" href="../variable-declarations/">Variables and parameters declaration</a></li><li><a class="tocitem" href="../model-declaration/">Model declaration</a></li><li><a class="tocitem" href="../steady-state/">Steady state</a></li><li><a class="tocitem" href="../shocks/">Shocks on exgogenous variables</a></li><li><a class="tocitem" href="../deterministic-simulations/">Deterministic simulations</a></li><li><a class="tocitem" href="../local-approxiation/">Local approximation</a></li><li><a class="tocitem" href="../filtersmoother/">State space, filtering and smoothing</a></li><li><a class="tocitem" href="../estimation/">Estimation</a></li><li><a class="tocitem" href="../forecasting/">Forecasting</a></li><li class="is-active"><a class="tocitem" href>Reporting</a></li></ul></li><li><a class="tocitem" href="../../macroprocessor/">Macroprocessing language</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">Model File</a></li><li class="is-active"><a href>Reporting</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Reporting</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/DynareJulia/Dynare.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/DynareJulia/Dynare.jl/blob/main/docs/src/model-file/reporting.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"><p>Dynare can generate PDF reports using \LaTeX</p><ul><li>A report is made of<ul><li>a title</li><li>a subtitle (optional)</li><li>pages</li></ul></li><li>A page is made of sections</li><li>A section can be<ul><li>a text paragraph</li><li>a listing of the model</li><li>a table</li><li>a graphic</li></ul></li></ul><h3 id="Julia-functions"><a class="docs-heading-anchor" href="#Julia-functions">Julia functions</a><a id="Julia-functions-1"></a><a class="docs-heading-anchor-permalink" href="#Julia-functions" title="Permalink"></a></h3><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Dynare.Report" href="#Dynare.Report"><code>Dynare.Report</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Report(title::String; subtitle::String = "")</p><p>initialize empty report</p><p><strong>Keyword arguments</strong></p><ul><li><code>title::String</code>: Report title [required]</li><li><code>subtitle::String</code>: Report subtitle</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/DynareJulia/Dynare.jl/blob/98d099264ed44e72da7ac845d8a0e3a860a5ef9b/src/reporting/report.jl#L53-L61">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Dynare.add_page!" href="#Dynare.add_page!"><code>Dynare.add_page!</code></a> — <span class="docstring-category">Function</span></header><section><div><p>add_page!(report::Report, page::Page)</p><p>adds a page to a report</p><p><strong>Keyword arguments</strong></p><ul><li><code>report::Report</code>: report</li><li><code>page::Page</code>: page to be added</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/DynareJulia/Dynare.jl/blob/98d099264ed44e72da7ac845d8a0e3a860a5ef9b/src/reporting/report.jl#L67-L75">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Dynare.add_graph!" href="#Dynare.add_graph!"><code>Dynare.add_graph!</code></a> — <span class="docstring-category">Function</span></header><section><div><p>add_graph!(page::Page, graph::Graph)</p><p>adds a graph to a page</p><p><strong>Keyword arguments</strong></p><ul><li><code>page::Page</code>: page</li><li><code>graph::Graph</code>: graph to be added</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/DynareJulia/Dynare.jl/blob/98d099264ed44e72da7ac845d8a0e3a860a5ef9b/src/reporting/report.jl#L80-L88">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Dynare.add_model!" href="#Dynare.add_model!"><code>Dynare.add_model!</code></a> — <span class="docstring-category">Function</span></header><section><div><p>add_model!(page::Page; context::Context = context, lastline::Int = 0, format = 1) adds the lines of a *.mod file to pages</p><p><strong>Keyword arguments</strong></p><ul><li><code>page::Page</code>: page [required]</li><li><code>context::Context</code>: context corresponding to the *.mod file (default: context)</li><li><code>lastline::Int</code>: last line to be printed</li><li><code>format::Int</code>: how to display parameter values 1: value is written after the parameter name 2: value is written below the parameter name</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/DynareJulia/Dynare.jl/blob/98d099264ed44e72da7ac845d8a0e3a860a5ef9b/src/reporting/report.jl#L93-L104">source</a></section></article><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="Dynare.add_paragraph!" href="#Dynare.add_paragraph!"><code>Dynare.add_paragraph!</code></a> — <span class="docstring-category">Function</span></header><section><div><p>add_paragraph!(page::Page, paragraph::String)</p><p>adds a graph to a page</p><p><strong>Keyword arguments</strong></p><ul><li><code>page::Page</code>: page</li><li><code>paragraph::String</code>: paragraph to be added</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/DynareJulia/Dynare.jl/blob/98d099264ed44e72da7ac845d8a0e3a860a5ef9b/src/reporting/report.jl#L117-L125">source</a></section></article><p>@docs add_table! ````</p><p>`<span>$@docs print$</span></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../forecasting/">« Forecasting</a><a class="docs-footer-nextpage" href="../../macroprocessor/">Macroprocessing language »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.3.0 on <span class="colophon-date" title="Thursday 28 March 2024 16:50">Thursday 28 March 2024</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.