Skip to content

Commit

Permalink
build based on 1cc8159
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 19, 2024
1 parent ea79675 commit 24be446
Show file tree
Hide file tree
Showing 8 changed files with 18 additions and 16 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-19T09:33:08","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-19T11:43:15","documenter_version":"1.7.0"}}
4 changes: 2 additions & 2 deletions dev/gallery/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,4 +42,4 @@
],
plugins=[bib],
)
deploydocs(; repo=&quot;github.com/JuliaDocs/DocumenterCitations.jl.git&quot;)</code></pre><p>Bibliographies are also supported in <a href="https://documenter.juliadocs.org/stable/man/other-formats/#pdf-output">PDFs generated via LaTeX</a>. All that is required is to replace <code>format=Documenter.HTML(…)</code> in the above code with <code>format=Documenter.LaTeX()</code>. See <a href="https://github.com/JuliaDocs/DocumenterCitations.jl/blob/master/docs/makepdf.jl"><code>docs/makepdf.jl</code></a> for an example. The resulting PDF files for the <code>DocumenterCitations</code> package are available as attachments to the <a href="https://github.com/JuliaDocs/DocumenterCitations.jl/releases">Releases</a>.</p><p>The rendering of the documentation may be fine-tuned using the <a href="internals/#DocumenterCitations.set_latex_options"><code>DocumenterCitations.set_latex_options</code></a> function. Note that the bibliography in LaTeX is directly rendered for the <a href="gallery/#gallery">different styles</a> from the same internal representation as the HTML version. In particular, <code>bibtex</code>/<code>biblatex</code> is not involved in producing the PDF.</p><h2 id="How-to-cite-references-in-your-documentation"><a class="docs-heading-anchor" href="#How-to-cite-references-in-your-documentation">How to cite references in your documentation</a><a id="How-to-cite-references-in-your-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-cite-references-in-your-documentation" title="Permalink"></a></h2><p>You can put citations anywhere in your docs, both in the markdown pages and in the docstrings of any functions that are shown as part of the API documentation: The basic syntax is, e.g., <code>[GoerzQ2022](@cite)</code>, for a BibTeX key <a href="references/#GoerzQ2022">GoerzQ2022</a> in <a href="refs.bib"><code>refs.bib</code></a>, which will be rendered in the default numeric style as &quot;[<a href="references/#GoerzQ2022">2</a>]&quot;. See <a href="syntax/#Syntax-for-Citations">Syntax for Citations</a> for more details.</p><p>Clicking on the citations takes you to the bibliography (&quot;<a href="references/#References">References</a>&quot;).</p><h2 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h2><p>The following is a list of some projects that use <code>DocumenterCitations</code>:</p><ul><li><a href="https://clima.github.io/OceananigansDocumentation/stable/">Oceananigans</a></li><li><a href="https://juliaquantumcontrol.github.io/QuantumPropagators.jl/">QuantumPropagators</a></li><li><a href="https://juliaquantumcontrol.github.io/QuantumControl.jl/">QuantumControl</a></li><li><a href="https://juliaquantumcontrol.github.io/TwoQubitWeylChamber.jl/">TwoQubitWeylChamber</a></li><li><a href="https://quantumsavory.github.io/QuantumClifford.jl/stable/references/">QuantumClifford</a> and the parent <a href="https://github.com/QuantumSavory">QuantumSavory organization</a></li></ul><h2 id="Home-References"><a class="docs-heading-anchor" href="#Home-References">Home References</a><a id="Home-References-1"></a><a class="docs-heading-anchor-permalink" href="#Home-References" title="Permalink"></a></h2><p>This page cites the following references:</p><div class="citation noncanonical"><dl><dt>[1]</dt><dd><div>C. Brif, R. Chakrabarti and H. Rabitz. <em>Control of quantum phenomena: past, present and future</em>. <a href="https://doi.org/10.1088/1367-2630/12/7/075008">New J. Phys. <strong>12</strong>, 075008</a> (2010).</div></dd><dt>[2]</dt><dd><div>M. H. Goerz, S. C. Carrasco and V. S. Malinovsky. <em>Quantum Optimal Control via Semi-Automatic Differentiation</em>. <a href="https://doi.org/10.22331/q-2022-12-07-871">Quantum <strong>6</strong>, 871</a> (2022).</div></dd></dl></div><p>Also see the <a href="references/#References">full bibliography</a> for further references cited throughout this documentation.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="syntax/">Syntax »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.3.3+dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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.7.0 on <span class="colophon-date" title="Thursday 19 September 2024 09:33">Thursday 19 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
deploydocs(; repo=&quot;github.com/JuliaDocs/DocumenterCitations.jl.git&quot;)</code></pre><p>Bibliographies are also supported in <a href="https://documenter.juliadocs.org/stable/man/other-formats/#pdf-output">PDFs generated via LaTeX</a>. All that is required is to replace <code>format=Documenter.HTML(…)</code> in the above code with <code>format=Documenter.LaTeX()</code>. See <a href="https://github.com/JuliaDocs/DocumenterCitations.jl/blob/master/docs/makepdf.jl"><code>docs/makepdf.jl</code></a> for an example. The resulting PDF files for the <code>DocumenterCitations</code> package are available as attachments to the <a href="https://github.com/JuliaDocs/DocumenterCitations.jl/releases">Releases</a>.</p><p>The rendering of the documentation may be fine-tuned using the <a href="internals/#DocumenterCitations.set_latex_options"><code>DocumenterCitations.set_latex_options</code></a> function. Note that the bibliography in LaTeX is directly rendered for the <a href="gallery/#gallery">different styles</a> from the same internal representation as the HTML version. In particular, <code>bibtex</code>/<code>biblatex</code> is not involved in producing the PDF.</p><h2 id="How-to-cite-references-in-your-documentation"><a class="docs-heading-anchor" href="#How-to-cite-references-in-your-documentation">How to cite references in your documentation</a><a id="How-to-cite-references-in-your-documentation-1"></a><a class="docs-heading-anchor-permalink" href="#How-to-cite-references-in-your-documentation" title="Permalink"></a></h2><p>You can put citations anywhere in your docs, both in the markdown pages and in the docstrings of any functions that are shown as part of the API documentation: The basic syntax is, e.g., <code>[GoerzQ2022](@cite)</code>, for a BibTeX key <a href="references/#GoerzQ2022">GoerzQ2022</a> in <a href="refs.bib"><code>refs.bib</code></a>, which will be rendered in the default numeric style as &quot;[<a href="references/#GoerzQ2022">2</a>]&quot;. See <a href="syntax/#Syntax-for-Citations">Syntax for Citations</a> for more details.</p><p>Clicking on the citations takes you to the bibliography (&quot;<a href="references/#References">References</a>&quot;).</p><h2 id="Examples"><a class="docs-heading-anchor" href="#Examples">Examples</a><a id="Examples-1"></a><a class="docs-heading-anchor-permalink" href="#Examples" title="Permalink"></a></h2><p>The following is a list of some projects that use <code>DocumenterCitations</code>:</p><ul><li><a href="https://clima.github.io/OceananigansDocumentation/stable/">Oceananigans</a></li><li><a href="https://juliaquantumcontrol.github.io/QuantumPropagators.jl/">QuantumPropagators</a></li><li><a href="https://juliaquantumcontrol.github.io/QuantumControl.jl/">QuantumControl</a></li><li><a href="https://juliaquantumcontrol.github.io/TwoQubitWeylChamber.jl/">TwoQubitWeylChamber</a></li><li><a href="https://quantumsavory.github.io/QuantumClifford.jl/stable/references/">QuantumClifford</a> and the parent <a href="https://github.com/QuantumSavory">QuantumSavory organization</a></li></ul><h2 id="Home-References"><a class="docs-heading-anchor" href="#Home-References">Home References</a><a id="Home-References-1"></a><a class="docs-heading-anchor-permalink" href="#Home-References" title="Permalink"></a></h2><p>This page cites the following references:</p><div class="citation noncanonical"><dl><dt>[1]</dt><dd><div>C. Brif, R. Chakrabarti and H. Rabitz. <em>Control of quantum phenomena: past, present and future</em>. <a href="https://doi.org/10.1088/1367-2630/12/7/075008">New J. Phys. <strong>12</strong>, 075008</a> (2010).</div></dd><dt>[2]</dt><dd><div>M. H. Goerz, S. C. Carrasco and V. S. Malinovsky. <em>Quantum Optimal Control via Semi-Automatic Differentiation</em>. <a href="https://doi.org/10.22331/q-2022-12-07-871">Quantum <strong>6</strong>, 871</a> (2022).</div></dd></dl></div><p>Also see the <a href="references/#References">full bibliography</a> for further references cited throughout this documentation.</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="syntax/">Syntax »</a><div class="flexbox-break"></div><p class="footer-message"><a href="https://github.com/JuliaDocs/DocumenterCitations.jl">DocumenterCitations.jl</a> v1.3.3+dev docs powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</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.7.0 on <span class="colophon-date" title="Thursday 19 September 2024 11:43">Thursday 19 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
16 changes: 9 additions & 7 deletions dev/internals/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit 24be446

Please sign in to comment.